ACPI: thinkpad-acpi: add development version tag
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / net / sunrpc / xprtsock.c
blobeb958197ae625ae3961adbadb3fa3150769b6e74
1 /*
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/slab.h>
23 #include <linux/module.h>
24 #include <linux/capability.h>
25 #include <linux/pagemap.h>
26 #include <linux/errno.h>
27 #include <linux/socket.h>
28 #include <linux/in.h>
29 #include <linux/net.h>
30 #include <linux/mm.h>
31 #include <linux/udp.h>
32 #include <linux/tcp.h>
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/sunrpc/sched.h>
35 #include <linux/sunrpc/svcsock.h>
36 #include <linux/sunrpc/xprtsock.h>
37 #include <linux/file.h>
38 #ifdef CONFIG_NFS_V4_1
39 #include <linux/sunrpc/bc_xprt.h>
40 #endif
42 #include <net/sock.h>
43 #include <net/checksum.h>
44 #include <net/udp.h>
45 #include <net/tcp.h>
47 #include "sunrpc.h"
49 * xprtsock tunables
51 unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE;
52 unsigned int xprt_tcp_slot_table_entries = RPC_DEF_SLOT_TABLE;
54 unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT;
55 unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT;
57 #define XS_TCP_LINGER_TO (15U * HZ)
58 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO;
61 * We can register our own files under /proc/sys/sunrpc by
62 * calling register_sysctl_table() again. The files in that
63 * directory become the union of all files registered there.
65 * We simply need to make sure that we don't collide with
66 * someone else's file names!
69 #ifdef RPC_DEBUG
71 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE;
72 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE;
73 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT;
74 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT;
76 static struct ctl_table_header *sunrpc_table_header;
79 * FIXME: changing the UDP slot table size should also resize the UDP
80 * socket buffers for existing UDP transports
82 static ctl_table xs_tunables_table[] = {
84 .procname = "udp_slot_table_entries",
85 .data = &xprt_udp_slot_table_entries,
86 .maxlen = sizeof(unsigned int),
87 .mode = 0644,
88 .proc_handler = proc_dointvec_minmax,
89 .extra1 = &min_slot_table_size,
90 .extra2 = &max_slot_table_size
93 .procname = "tcp_slot_table_entries",
94 .data = &xprt_tcp_slot_table_entries,
95 .maxlen = sizeof(unsigned int),
96 .mode = 0644,
97 .proc_handler = proc_dointvec_minmax,
98 .extra1 = &min_slot_table_size,
99 .extra2 = &max_slot_table_size
102 .procname = "min_resvport",
103 .data = &xprt_min_resvport,
104 .maxlen = sizeof(unsigned int),
105 .mode = 0644,
106 .proc_handler = proc_dointvec_minmax,
107 .extra1 = &xprt_min_resvport_limit,
108 .extra2 = &xprt_max_resvport_limit
111 .procname = "max_resvport",
112 .data = &xprt_max_resvport,
113 .maxlen = sizeof(unsigned int),
114 .mode = 0644,
115 .proc_handler = proc_dointvec_minmax,
116 .extra1 = &xprt_min_resvport_limit,
117 .extra2 = &xprt_max_resvport_limit
120 .procname = "tcp_fin_timeout",
121 .data = &xs_tcp_fin_timeout,
122 .maxlen = sizeof(xs_tcp_fin_timeout),
123 .mode = 0644,
124 .proc_handler = proc_dointvec_jiffies,
126 { },
129 static ctl_table sunrpc_table[] = {
131 .procname = "sunrpc",
132 .mode = 0555,
133 .child = xs_tunables_table
135 { },
138 #endif
141 * Wait duration for a reply from the RPC portmapper.
143 #define XS_BIND_TO (60U * HZ)
146 * Delay if a UDP socket connect error occurs. This is most likely some
147 * kind of resource problem on the local host.
149 #define XS_UDP_REEST_TO (2U * HZ)
152 * The reestablish timeout allows clients to delay for a bit before attempting
153 * to reconnect to a server that just dropped our connection.
155 * We implement an exponential backoff when trying to reestablish a TCP
156 * transport connection with the server. Some servers like to drop a TCP
157 * connection when they are overworked, so we start with a short timeout and
158 * increase over time if the server is down or not responding.
160 #define XS_TCP_INIT_REEST_TO (3U * HZ)
161 #define XS_TCP_MAX_REEST_TO (5U * 60 * HZ)
164 * TCP idle timeout; client drops the transport socket if it is idle
165 * for this long. Note that we also timeout UDP sockets to prevent
166 * holding port numbers when there is no RPC traffic.
168 #define XS_IDLE_DISC_TO (5U * 60 * HZ)
170 #ifdef RPC_DEBUG
171 # undef RPC_DEBUG_DATA
172 # define RPCDBG_FACILITY RPCDBG_TRANS
173 #endif
175 #ifdef RPC_DEBUG_DATA
176 static void xs_pktdump(char *msg, u32 *packet, unsigned int count)
178 u8 *buf = (u8 *) packet;
179 int j;
181 dprintk("RPC: %s\n", msg);
182 for (j = 0; j < count && j < 128; j += 4) {
183 if (!(j & 31)) {
184 if (j)
185 dprintk("\n");
186 dprintk("0x%04x ", j);
188 dprintk("%02x%02x%02x%02x ",
189 buf[j], buf[j+1], buf[j+2], buf[j+3]);
191 dprintk("\n");
193 #else
194 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count)
196 /* NOP */
198 #endif
200 struct sock_xprt {
201 struct rpc_xprt xprt;
204 * Network layer
206 struct socket * sock;
207 struct sock * inet;
210 * State of TCP reply receive
212 __be32 tcp_fraghdr,
213 tcp_xid,
214 tcp_calldir;
216 u32 tcp_offset,
217 tcp_reclen;
219 unsigned long tcp_copied,
220 tcp_flags;
223 * Connection of transports
225 struct delayed_work connect_worker;
226 struct sockaddr_storage srcaddr;
227 unsigned short srcport;
230 * UDP socket buffer size parameters
232 size_t rcvsize,
233 sndsize;
236 * Saved socket callback addresses
238 void (*old_data_ready)(struct sock *, int);
239 void (*old_state_change)(struct sock *);
240 void (*old_write_space)(struct sock *);
241 void (*old_error_report)(struct sock *);
245 * TCP receive state flags
247 #define TCP_RCV_LAST_FRAG (1UL << 0)
248 #define TCP_RCV_COPY_FRAGHDR (1UL << 1)
249 #define TCP_RCV_COPY_XID (1UL << 2)
250 #define TCP_RCV_COPY_DATA (1UL << 3)
251 #define TCP_RCV_READ_CALLDIR (1UL << 4)
252 #define TCP_RCV_COPY_CALLDIR (1UL << 5)
255 * TCP RPC flags
257 #define TCP_RPC_REPLY (1UL << 6)
259 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt)
261 return (struct sockaddr *) &xprt->addr;
264 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt)
266 return (struct sockaddr_in *) &xprt->addr;
269 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt)
271 return (struct sockaddr_in6 *) &xprt->addr;
274 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt)
276 struct sockaddr *sap = xs_addr(xprt);
277 struct sockaddr_in6 *sin6;
278 struct sockaddr_in *sin;
279 char buf[128];
281 (void)rpc_ntop(sap, buf, sizeof(buf));
282 xprt->address_strings[RPC_DISPLAY_ADDR] = kstrdup(buf, GFP_KERNEL);
284 switch (sap->sa_family) {
285 case AF_INET:
286 sin = xs_addr_in(xprt);
287 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr));
288 break;
289 case AF_INET6:
290 sin6 = xs_addr_in6(xprt);
291 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr);
292 break;
293 default:
294 BUG();
296 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL);
299 static void xs_format_common_peer_ports(struct rpc_xprt *xprt)
301 struct sockaddr *sap = xs_addr(xprt);
302 char buf[128];
304 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap));
305 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL);
307 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap));
308 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL);
311 static void xs_format_peer_addresses(struct rpc_xprt *xprt,
312 const char *protocol,
313 const char *netid)
315 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol;
316 xprt->address_strings[RPC_DISPLAY_NETID] = netid;
317 xs_format_common_peer_addresses(xprt);
318 xs_format_common_peer_ports(xprt);
321 static void xs_update_peer_port(struct rpc_xprt *xprt)
323 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]);
324 kfree(xprt->address_strings[RPC_DISPLAY_PORT]);
326 xs_format_common_peer_ports(xprt);
329 static void xs_free_peer_addresses(struct rpc_xprt *xprt)
331 unsigned int i;
333 for (i = 0; i < RPC_DISPLAY_MAX; i++)
334 switch (i) {
335 case RPC_DISPLAY_PROTO:
336 case RPC_DISPLAY_NETID:
337 continue;
338 default:
339 kfree(xprt->address_strings[i]);
343 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL)
345 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more)
347 struct msghdr msg = {
348 .msg_name = addr,
349 .msg_namelen = addrlen,
350 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0),
352 struct kvec iov = {
353 .iov_base = vec->iov_base + base,
354 .iov_len = vec->iov_len - base,
357 if (iov.iov_len != 0)
358 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len);
359 return kernel_sendmsg(sock, &msg, NULL, 0, 0);
362 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more)
364 struct page **ppage;
365 unsigned int remainder;
366 int err, sent = 0;
368 remainder = xdr->page_len - base;
369 base += xdr->page_base;
370 ppage = xdr->pages + (base >> PAGE_SHIFT);
371 base &= ~PAGE_MASK;
372 for(;;) {
373 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder);
374 int flags = XS_SENDMSG_FLAGS;
376 remainder -= len;
377 if (remainder != 0 || more)
378 flags |= MSG_MORE;
379 err = sock->ops->sendpage(sock, *ppage, base, len, flags);
380 if (remainder == 0 || err != len)
381 break;
382 sent += err;
383 ppage++;
384 base = 0;
386 if (sent == 0)
387 return err;
388 if (err > 0)
389 sent += err;
390 return sent;
394 * xs_sendpages - write pages directly to a socket
395 * @sock: socket to send on
396 * @addr: UDP only -- address of destination
397 * @addrlen: UDP only -- length of destination address
398 * @xdr: buffer containing this request
399 * @base: starting position in the buffer
402 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base)
404 unsigned int remainder = xdr->len - base;
405 int err, sent = 0;
407 if (unlikely(!sock))
408 return -ENOTSOCK;
410 clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags);
411 if (base != 0) {
412 addr = NULL;
413 addrlen = 0;
416 if (base < xdr->head[0].iov_len || addr != NULL) {
417 unsigned int len = xdr->head[0].iov_len - base;
418 remainder -= len;
419 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0);
420 if (remainder == 0 || err != len)
421 goto out;
422 sent += err;
423 base = 0;
424 } else
425 base -= xdr->head[0].iov_len;
427 if (base < xdr->page_len) {
428 unsigned int len = xdr->page_len - base;
429 remainder -= len;
430 err = xs_send_pagedata(sock, xdr, base, remainder != 0);
431 if (remainder == 0 || err != len)
432 goto out;
433 sent += err;
434 base = 0;
435 } else
436 base -= xdr->page_len;
438 if (base >= xdr->tail[0].iov_len)
439 return sent;
440 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0);
441 out:
442 if (sent == 0)
443 return err;
444 if (err > 0)
445 sent += err;
446 return sent;
449 static void xs_nospace_callback(struct rpc_task *task)
451 struct sock_xprt *transport = container_of(task->tk_rqstp->rq_xprt, struct sock_xprt, xprt);
453 transport->inet->sk_write_pending--;
454 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
458 * xs_nospace - place task on wait queue if transmit was incomplete
459 * @task: task to put to sleep
462 static int xs_nospace(struct rpc_task *task)
464 struct rpc_rqst *req = task->tk_rqstp;
465 struct rpc_xprt *xprt = req->rq_xprt;
466 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
467 int ret = 0;
469 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n",
470 task->tk_pid, req->rq_slen - req->rq_bytes_sent,
471 req->rq_slen);
473 /* Protect against races with write_space */
474 spin_lock_bh(&xprt->transport_lock);
476 /* Don't race with disconnect */
477 if (xprt_connected(xprt)) {
478 if (test_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags)) {
479 ret = -EAGAIN;
481 * Notify TCP that we're limited by the application
482 * window size
484 set_bit(SOCK_NOSPACE, &transport->sock->flags);
485 transport->inet->sk_write_pending++;
486 /* ...and wait for more buffer space */
487 xprt_wait_for_buffer_space(task, xs_nospace_callback);
489 } else {
490 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
491 ret = -ENOTCONN;
494 spin_unlock_bh(&xprt->transport_lock);
495 return ret;
499 * xs_udp_send_request - write an RPC request to a UDP socket
500 * @task: address of RPC task that manages the state of an RPC request
502 * Return values:
503 * 0: The request has been sent
504 * EAGAIN: The socket was blocked, please call again later to
505 * complete the request
506 * ENOTCONN: Caller needs to invoke connect logic then call again
507 * other: Some other error occured, the request was not sent
509 static int xs_udp_send_request(struct rpc_task *task)
511 struct rpc_rqst *req = task->tk_rqstp;
512 struct rpc_xprt *xprt = req->rq_xprt;
513 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
514 struct xdr_buf *xdr = &req->rq_snd_buf;
515 int status;
517 xs_pktdump("packet data:",
518 req->rq_svec->iov_base,
519 req->rq_svec->iov_len);
521 if (!xprt_bound(xprt))
522 return -ENOTCONN;
523 status = xs_sendpages(transport->sock,
524 xs_addr(xprt),
525 xprt->addrlen, xdr,
526 req->rq_bytes_sent);
528 dprintk("RPC: xs_udp_send_request(%u) = %d\n",
529 xdr->len - req->rq_bytes_sent, status);
531 if (status >= 0) {
532 req->rq_xmit_bytes_sent += status;
533 if (status >= req->rq_slen)
534 return 0;
535 /* Still some bytes left; set up for a retry later. */
536 status = -EAGAIN;
539 switch (status) {
540 case -ENOTSOCK:
541 status = -ENOTCONN;
542 /* Should we call xs_close() here? */
543 break;
544 case -EAGAIN:
545 status = xs_nospace(task);
546 break;
547 default:
548 dprintk("RPC: sendmsg returned unrecognized error %d\n",
549 -status);
550 case -ENETUNREACH:
551 case -EPIPE:
552 case -ECONNREFUSED:
553 /* When the server has died, an ICMP port unreachable message
554 * prompts ECONNREFUSED. */
555 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
558 return status;
562 * xs_tcp_shutdown - gracefully shut down a TCP socket
563 * @xprt: transport
565 * Initiates a graceful shutdown of the TCP socket by calling the
566 * equivalent of shutdown(SHUT_WR);
568 static void xs_tcp_shutdown(struct rpc_xprt *xprt)
570 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
571 struct socket *sock = transport->sock;
573 if (sock != NULL)
574 kernel_sock_shutdown(sock, SHUT_WR);
577 static inline void xs_encode_tcp_record_marker(struct xdr_buf *buf)
579 u32 reclen = buf->len - sizeof(rpc_fraghdr);
580 rpc_fraghdr *base = buf->head[0].iov_base;
581 *base = htonl(RPC_LAST_STREAM_FRAGMENT | reclen);
585 * xs_tcp_send_request - write an RPC request to a TCP socket
586 * @task: address of RPC task that manages the state of an RPC request
588 * Return values:
589 * 0: The request has been sent
590 * EAGAIN: The socket was blocked, please call again later to
591 * complete the request
592 * ENOTCONN: Caller needs to invoke connect logic then call again
593 * other: Some other error occured, the request was not sent
595 * XXX: In the case of soft timeouts, should we eventually give up
596 * if sendmsg is not able to make progress?
598 static int xs_tcp_send_request(struct rpc_task *task)
600 struct rpc_rqst *req = task->tk_rqstp;
601 struct rpc_xprt *xprt = req->rq_xprt;
602 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
603 struct xdr_buf *xdr = &req->rq_snd_buf;
604 int status;
606 xs_encode_tcp_record_marker(&req->rq_snd_buf);
608 xs_pktdump("packet data:",
609 req->rq_svec->iov_base,
610 req->rq_svec->iov_len);
612 /* Continue transmitting the packet/record. We must be careful
613 * to cope with writespace callbacks arriving _after_ we have
614 * called sendmsg(). */
615 while (1) {
616 status = xs_sendpages(transport->sock,
617 NULL, 0, xdr, req->rq_bytes_sent);
619 dprintk("RPC: xs_tcp_send_request(%u) = %d\n",
620 xdr->len - req->rq_bytes_sent, status);
622 if (unlikely(status < 0))
623 break;
625 /* If we've sent the entire packet, immediately
626 * reset the count of bytes sent. */
627 req->rq_bytes_sent += status;
628 req->rq_xmit_bytes_sent += status;
629 if (likely(req->rq_bytes_sent >= req->rq_slen)) {
630 req->rq_bytes_sent = 0;
631 return 0;
634 if (status != 0)
635 continue;
636 status = -EAGAIN;
637 break;
640 switch (status) {
641 case -ENOTSOCK:
642 status = -ENOTCONN;
643 /* Should we call xs_close() here? */
644 break;
645 case -EAGAIN:
646 status = xs_nospace(task);
647 break;
648 default:
649 dprintk("RPC: sendmsg returned unrecognized error %d\n",
650 -status);
651 case -ECONNRESET:
652 case -EPIPE:
653 xs_tcp_shutdown(xprt);
654 case -ECONNREFUSED:
655 case -ENOTCONN:
656 clear_bit(SOCK_ASYNC_NOSPACE, &transport->sock->flags);
659 return status;
663 * xs_tcp_release_xprt - clean up after a tcp transmission
664 * @xprt: transport
665 * @task: rpc task
667 * This cleans up if an error causes us to abort the transmission of a request.
668 * In this case, the socket may need to be reset in order to avoid confusing
669 * the server.
671 static void xs_tcp_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
673 struct rpc_rqst *req;
675 if (task != xprt->snd_task)
676 return;
677 if (task == NULL)
678 goto out_release;
679 req = task->tk_rqstp;
680 if (req->rq_bytes_sent == 0)
681 goto out_release;
682 if (req->rq_bytes_sent == req->rq_snd_buf.len)
683 goto out_release;
684 set_bit(XPRT_CLOSE_WAIT, &task->tk_xprt->state);
685 out_release:
686 xprt_release_xprt(xprt, task);
689 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk)
691 transport->old_data_ready = sk->sk_data_ready;
692 transport->old_state_change = sk->sk_state_change;
693 transport->old_write_space = sk->sk_write_space;
694 transport->old_error_report = sk->sk_error_report;
697 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk)
699 sk->sk_data_ready = transport->old_data_ready;
700 sk->sk_state_change = transport->old_state_change;
701 sk->sk_write_space = transport->old_write_space;
702 sk->sk_error_report = transport->old_error_report;
705 static void xs_reset_transport(struct sock_xprt *transport)
707 struct socket *sock = transport->sock;
708 struct sock *sk = transport->inet;
710 if (sk == NULL)
711 return;
713 transport->srcport = 0;
715 write_lock_bh(&sk->sk_callback_lock);
716 transport->inet = NULL;
717 transport->sock = NULL;
719 sk->sk_user_data = NULL;
721 xs_restore_old_callbacks(transport, sk);
722 write_unlock_bh(&sk->sk_callback_lock);
724 sk->sk_no_check = 0;
726 sock_release(sock);
730 * xs_close - close a socket
731 * @xprt: transport
733 * This is used when all requests are complete; ie, no DRC state remains
734 * on the server we want to save.
736 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with
737 * xs_reset_transport() zeroing the socket from underneath a writer.
739 static void xs_close(struct rpc_xprt *xprt)
741 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
743 dprintk("RPC: xs_close xprt %p\n", xprt);
745 xs_reset_transport(transport);
746 xprt->reestablish_timeout = 0;
748 smp_mb__before_clear_bit();
749 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
750 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
751 clear_bit(XPRT_CLOSING, &xprt->state);
752 smp_mb__after_clear_bit();
753 xprt_disconnect_done(xprt);
756 static void xs_tcp_close(struct rpc_xprt *xprt)
758 if (test_and_clear_bit(XPRT_CONNECTION_CLOSE, &xprt->state))
759 xs_close(xprt);
760 else
761 xs_tcp_shutdown(xprt);
765 * xs_destroy - prepare to shutdown a transport
766 * @xprt: doomed transport
769 static void xs_destroy(struct rpc_xprt *xprt)
771 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
773 dprintk("RPC: xs_destroy xprt %p\n", xprt);
775 cancel_rearming_delayed_work(&transport->connect_worker);
777 xs_close(xprt);
778 xs_free_peer_addresses(xprt);
779 kfree(xprt->slot);
780 kfree(xprt);
781 module_put(THIS_MODULE);
784 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk)
786 return (struct rpc_xprt *) sk->sk_user_data;
790 * xs_udp_data_ready - "data ready" callback for UDP sockets
791 * @sk: socket with data to read
792 * @len: how much data to read
795 static void xs_udp_data_ready(struct sock *sk, int len)
797 struct rpc_task *task;
798 struct rpc_xprt *xprt;
799 struct rpc_rqst *rovr;
800 struct sk_buff *skb;
801 int err, repsize, copied;
802 u32 _xid;
803 __be32 *xp;
805 read_lock(&sk->sk_callback_lock);
806 dprintk("RPC: xs_udp_data_ready...\n");
807 if (!(xprt = xprt_from_sock(sk)))
808 goto out;
810 if ((skb = skb_recv_datagram(sk, 0, 1, &err)) == NULL)
811 goto out;
813 if (xprt->shutdown)
814 goto dropit;
816 repsize = skb->len - sizeof(struct udphdr);
817 if (repsize < 4) {
818 dprintk("RPC: impossible RPC reply size %d!\n", repsize);
819 goto dropit;
822 /* Copy the XID from the skb... */
823 xp = skb_header_pointer(skb, sizeof(struct udphdr),
824 sizeof(_xid), &_xid);
825 if (xp == NULL)
826 goto dropit;
828 /* Look up and lock the request corresponding to the given XID */
829 spin_lock(&xprt->transport_lock);
830 rovr = xprt_lookup_rqst(xprt, *xp);
831 if (!rovr)
832 goto out_unlock;
833 task = rovr->rq_task;
835 if ((copied = rovr->rq_private_buf.buflen) > repsize)
836 copied = repsize;
838 /* Suck it into the iovec, verify checksum if not done by hw. */
839 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) {
840 UDPX_INC_STATS_BH(sk, UDP_MIB_INERRORS);
841 goto out_unlock;
844 UDPX_INC_STATS_BH(sk, UDP_MIB_INDATAGRAMS);
846 /* Something worked... */
847 dst_confirm(skb_dst(skb));
849 xprt_adjust_cwnd(task, copied);
850 xprt_complete_rqst(task, copied);
852 out_unlock:
853 spin_unlock(&xprt->transport_lock);
854 dropit:
855 skb_free_datagram(sk, skb);
856 out:
857 read_unlock(&sk->sk_callback_lock);
860 static inline void xs_tcp_read_fraghdr(struct rpc_xprt *xprt, struct xdr_skb_reader *desc)
862 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
863 size_t len, used;
864 char *p;
866 p = ((char *) &transport->tcp_fraghdr) + transport->tcp_offset;
867 len = sizeof(transport->tcp_fraghdr) - transport->tcp_offset;
868 used = xdr_skb_read_bits(desc, p, len);
869 transport->tcp_offset += used;
870 if (used != len)
871 return;
873 transport->tcp_reclen = ntohl(transport->tcp_fraghdr);
874 if (transport->tcp_reclen & RPC_LAST_STREAM_FRAGMENT)
875 transport->tcp_flags |= TCP_RCV_LAST_FRAG;
876 else
877 transport->tcp_flags &= ~TCP_RCV_LAST_FRAG;
878 transport->tcp_reclen &= RPC_FRAGMENT_SIZE_MASK;
880 transport->tcp_flags &= ~TCP_RCV_COPY_FRAGHDR;
881 transport->tcp_offset = 0;
883 /* Sanity check of the record length */
884 if (unlikely(transport->tcp_reclen < 8)) {
885 dprintk("RPC: invalid TCP record fragment length\n");
886 xprt_force_disconnect(xprt);
887 return;
889 dprintk("RPC: reading TCP record fragment of length %d\n",
890 transport->tcp_reclen);
893 static void xs_tcp_check_fraghdr(struct sock_xprt *transport)
895 if (transport->tcp_offset == transport->tcp_reclen) {
896 transport->tcp_flags |= TCP_RCV_COPY_FRAGHDR;
897 transport->tcp_offset = 0;
898 if (transport->tcp_flags & TCP_RCV_LAST_FRAG) {
899 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
900 transport->tcp_flags |= TCP_RCV_COPY_XID;
901 transport->tcp_copied = 0;
906 static inline void xs_tcp_read_xid(struct sock_xprt *transport, struct xdr_skb_reader *desc)
908 size_t len, used;
909 char *p;
911 len = sizeof(transport->tcp_xid) - transport->tcp_offset;
912 dprintk("RPC: reading XID (%Zu bytes)\n", len);
913 p = ((char *) &transport->tcp_xid) + transport->tcp_offset;
914 used = xdr_skb_read_bits(desc, p, len);
915 transport->tcp_offset += used;
916 if (used != len)
917 return;
918 transport->tcp_flags &= ~TCP_RCV_COPY_XID;
919 transport->tcp_flags |= TCP_RCV_READ_CALLDIR;
920 transport->tcp_copied = 4;
921 dprintk("RPC: reading %s XID %08x\n",
922 (transport->tcp_flags & TCP_RPC_REPLY) ? "reply for"
923 : "request with",
924 ntohl(transport->tcp_xid));
925 xs_tcp_check_fraghdr(transport);
928 static inline void xs_tcp_read_calldir(struct sock_xprt *transport,
929 struct xdr_skb_reader *desc)
931 size_t len, used;
932 u32 offset;
933 char *p;
936 * We want transport->tcp_offset to be 8 at the end of this routine
937 * (4 bytes for the xid and 4 bytes for the call/reply flag).
938 * When this function is called for the first time,
939 * transport->tcp_offset is 4 (after having already read the xid).
941 offset = transport->tcp_offset - sizeof(transport->tcp_xid);
942 len = sizeof(transport->tcp_calldir) - offset;
943 dprintk("RPC: reading CALL/REPLY flag (%Zu bytes)\n", len);
944 p = ((char *) &transport->tcp_calldir) + offset;
945 used = xdr_skb_read_bits(desc, p, len);
946 transport->tcp_offset += used;
947 if (used != len)
948 return;
949 transport->tcp_flags &= ~TCP_RCV_READ_CALLDIR;
951 * We don't yet have the XDR buffer, so we will write the calldir
952 * out after we get the buffer from the 'struct rpc_rqst'
954 switch (ntohl(transport->tcp_calldir)) {
955 case RPC_REPLY:
956 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
957 transport->tcp_flags |= TCP_RCV_COPY_DATA;
958 transport->tcp_flags |= TCP_RPC_REPLY;
959 break;
960 case RPC_CALL:
961 transport->tcp_flags |= TCP_RCV_COPY_CALLDIR;
962 transport->tcp_flags |= TCP_RCV_COPY_DATA;
963 transport->tcp_flags &= ~TCP_RPC_REPLY;
964 break;
965 default:
966 dprintk("RPC: invalid request message type\n");
967 xprt_force_disconnect(&transport->xprt);
969 xs_tcp_check_fraghdr(transport);
972 static inline void xs_tcp_read_common(struct rpc_xprt *xprt,
973 struct xdr_skb_reader *desc,
974 struct rpc_rqst *req)
976 struct sock_xprt *transport =
977 container_of(xprt, struct sock_xprt, xprt);
978 struct xdr_buf *rcvbuf;
979 size_t len;
980 ssize_t r;
982 rcvbuf = &req->rq_private_buf;
984 if (transport->tcp_flags & TCP_RCV_COPY_CALLDIR) {
986 * Save the RPC direction in the XDR buffer
988 memcpy(rcvbuf->head[0].iov_base + transport->tcp_copied,
989 &transport->tcp_calldir,
990 sizeof(transport->tcp_calldir));
991 transport->tcp_copied += sizeof(transport->tcp_calldir);
992 transport->tcp_flags &= ~TCP_RCV_COPY_CALLDIR;
995 len = desc->count;
996 if (len > transport->tcp_reclen - transport->tcp_offset) {
997 struct xdr_skb_reader my_desc;
999 len = transport->tcp_reclen - transport->tcp_offset;
1000 memcpy(&my_desc, desc, sizeof(my_desc));
1001 my_desc.count = len;
1002 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1003 &my_desc, xdr_skb_read_bits);
1004 desc->count -= r;
1005 desc->offset += r;
1006 } else
1007 r = xdr_partial_copy_from_skb(rcvbuf, transport->tcp_copied,
1008 desc, xdr_skb_read_bits);
1010 if (r > 0) {
1011 transport->tcp_copied += r;
1012 transport->tcp_offset += r;
1014 if (r != len) {
1015 /* Error when copying to the receive buffer,
1016 * usually because we weren't able to allocate
1017 * additional buffer pages. All we can do now
1018 * is turn off TCP_RCV_COPY_DATA, so the request
1019 * will not receive any additional updates,
1020 * and time out.
1021 * Any remaining data from this record will
1022 * be discarded.
1024 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1025 dprintk("RPC: XID %08x truncated request\n",
1026 ntohl(transport->tcp_xid));
1027 dprintk("RPC: xprt = %p, tcp_copied = %lu, "
1028 "tcp_offset = %u, tcp_reclen = %u\n",
1029 xprt, transport->tcp_copied,
1030 transport->tcp_offset, transport->tcp_reclen);
1031 return;
1034 dprintk("RPC: XID %08x read %Zd bytes\n",
1035 ntohl(transport->tcp_xid), r);
1036 dprintk("RPC: xprt = %p, tcp_copied = %lu, tcp_offset = %u, "
1037 "tcp_reclen = %u\n", xprt, transport->tcp_copied,
1038 transport->tcp_offset, transport->tcp_reclen);
1040 if (transport->tcp_copied == req->rq_private_buf.buflen)
1041 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1042 else if (transport->tcp_offset == transport->tcp_reclen) {
1043 if (transport->tcp_flags & TCP_RCV_LAST_FRAG)
1044 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1049 * Finds the request corresponding to the RPC xid and invokes the common
1050 * tcp read code to read the data.
1052 static inline int xs_tcp_read_reply(struct rpc_xprt *xprt,
1053 struct xdr_skb_reader *desc)
1055 struct sock_xprt *transport =
1056 container_of(xprt, struct sock_xprt, xprt);
1057 struct rpc_rqst *req;
1059 dprintk("RPC: read reply XID %08x\n", ntohl(transport->tcp_xid));
1061 /* Find and lock the request corresponding to this xid */
1062 spin_lock(&xprt->transport_lock);
1063 req = xprt_lookup_rqst(xprt, transport->tcp_xid);
1064 if (!req) {
1065 dprintk("RPC: XID %08x request not found!\n",
1066 ntohl(transport->tcp_xid));
1067 spin_unlock(&xprt->transport_lock);
1068 return -1;
1071 xs_tcp_read_common(xprt, desc, req);
1073 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA))
1074 xprt_complete_rqst(req->rq_task, transport->tcp_copied);
1076 spin_unlock(&xprt->transport_lock);
1077 return 0;
1080 #if defined(CONFIG_NFS_V4_1)
1082 * Obtains an rpc_rqst previously allocated and invokes the common
1083 * tcp read code to read the data. The result is placed in the callback
1084 * queue.
1085 * If we're unable to obtain the rpc_rqst we schedule the closing of the
1086 * connection and return -1.
1088 static inline int xs_tcp_read_callback(struct rpc_xprt *xprt,
1089 struct xdr_skb_reader *desc)
1091 struct sock_xprt *transport =
1092 container_of(xprt, struct sock_xprt, xprt);
1093 struct rpc_rqst *req;
1095 req = xprt_alloc_bc_request(xprt);
1096 if (req == NULL) {
1097 printk(KERN_WARNING "Callback slot table overflowed\n");
1098 xprt_force_disconnect(xprt);
1099 return -1;
1102 req->rq_xid = transport->tcp_xid;
1103 dprintk("RPC: read callback XID %08x\n", ntohl(req->rq_xid));
1104 xs_tcp_read_common(xprt, desc, req);
1106 if (!(transport->tcp_flags & TCP_RCV_COPY_DATA)) {
1107 struct svc_serv *bc_serv = xprt->bc_serv;
1110 * Add callback request to callback list. The callback
1111 * service sleeps on the sv_cb_waitq waiting for new
1112 * requests. Wake it up after adding enqueing the
1113 * request.
1115 dprintk("RPC: add callback request to list\n");
1116 spin_lock(&bc_serv->sv_cb_lock);
1117 list_add(&req->rq_bc_list, &bc_serv->sv_cb_list);
1118 spin_unlock(&bc_serv->sv_cb_lock);
1119 wake_up(&bc_serv->sv_cb_waitq);
1122 req->rq_private_buf.len = transport->tcp_copied;
1124 return 0;
1127 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1128 struct xdr_skb_reader *desc)
1130 struct sock_xprt *transport =
1131 container_of(xprt, struct sock_xprt, xprt);
1133 return (transport->tcp_flags & TCP_RPC_REPLY) ?
1134 xs_tcp_read_reply(xprt, desc) :
1135 xs_tcp_read_callback(xprt, desc);
1137 #else
1138 static inline int _xs_tcp_read_data(struct rpc_xprt *xprt,
1139 struct xdr_skb_reader *desc)
1141 return xs_tcp_read_reply(xprt, desc);
1143 #endif /* CONFIG_NFS_V4_1 */
1146 * Read data off the transport. This can be either an RPC_CALL or an
1147 * RPC_REPLY. Relay the processing to helper functions.
1149 static void xs_tcp_read_data(struct rpc_xprt *xprt,
1150 struct xdr_skb_reader *desc)
1152 struct sock_xprt *transport =
1153 container_of(xprt, struct sock_xprt, xprt);
1155 if (_xs_tcp_read_data(xprt, desc) == 0)
1156 xs_tcp_check_fraghdr(transport);
1157 else {
1159 * The transport_lock protects the request handling.
1160 * There's no need to hold it to update the tcp_flags.
1162 transport->tcp_flags &= ~TCP_RCV_COPY_DATA;
1166 static inline void xs_tcp_read_discard(struct sock_xprt *transport, struct xdr_skb_reader *desc)
1168 size_t len;
1170 len = transport->tcp_reclen - transport->tcp_offset;
1171 if (len > desc->count)
1172 len = desc->count;
1173 desc->count -= len;
1174 desc->offset += len;
1175 transport->tcp_offset += len;
1176 dprintk("RPC: discarded %Zu bytes\n", len);
1177 xs_tcp_check_fraghdr(transport);
1180 static int xs_tcp_data_recv(read_descriptor_t *rd_desc, struct sk_buff *skb, unsigned int offset, size_t len)
1182 struct rpc_xprt *xprt = rd_desc->arg.data;
1183 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1184 struct xdr_skb_reader desc = {
1185 .skb = skb,
1186 .offset = offset,
1187 .count = len,
1190 dprintk("RPC: xs_tcp_data_recv started\n");
1191 do {
1192 /* Read in a new fragment marker if necessary */
1193 /* Can we ever really expect to get completely empty fragments? */
1194 if (transport->tcp_flags & TCP_RCV_COPY_FRAGHDR) {
1195 xs_tcp_read_fraghdr(xprt, &desc);
1196 continue;
1198 /* Read in the xid if necessary */
1199 if (transport->tcp_flags & TCP_RCV_COPY_XID) {
1200 xs_tcp_read_xid(transport, &desc);
1201 continue;
1203 /* Read in the call/reply flag */
1204 if (transport->tcp_flags & TCP_RCV_READ_CALLDIR) {
1205 xs_tcp_read_calldir(transport, &desc);
1206 continue;
1208 /* Read in the request data */
1209 if (transport->tcp_flags & TCP_RCV_COPY_DATA) {
1210 xs_tcp_read_data(xprt, &desc);
1211 continue;
1213 /* Skip over any trailing bytes on short reads */
1214 xs_tcp_read_discard(transport, &desc);
1215 } while (desc.count);
1216 dprintk("RPC: xs_tcp_data_recv done\n");
1217 return len - desc.count;
1221 * xs_tcp_data_ready - "data ready" callback for TCP sockets
1222 * @sk: socket with data to read
1223 * @bytes: how much data to read
1226 static void xs_tcp_data_ready(struct sock *sk, int bytes)
1228 struct rpc_xprt *xprt;
1229 read_descriptor_t rd_desc;
1230 int read;
1232 dprintk("RPC: xs_tcp_data_ready...\n");
1234 read_lock(&sk->sk_callback_lock);
1235 if (!(xprt = xprt_from_sock(sk)))
1236 goto out;
1237 if (xprt->shutdown)
1238 goto out;
1240 /* Any data means we had a useful conversation, so
1241 * the we don't need to delay the next reconnect
1243 if (xprt->reestablish_timeout)
1244 xprt->reestablish_timeout = 0;
1246 /* We use rd_desc to pass struct xprt to xs_tcp_data_recv */
1247 rd_desc.arg.data = xprt;
1248 do {
1249 rd_desc.count = 65536;
1250 read = tcp_read_sock(sk, &rd_desc, xs_tcp_data_recv);
1251 } while (read > 0);
1252 out:
1253 read_unlock(&sk->sk_callback_lock);
1257 * Do the equivalent of linger/linger2 handling for dealing with
1258 * broken servers that don't close the socket in a timely
1259 * fashion
1261 static void xs_tcp_schedule_linger_timeout(struct rpc_xprt *xprt,
1262 unsigned long timeout)
1264 struct sock_xprt *transport;
1266 if (xprt_test_and_set_connecting(xprt))
1267 return;
1268 set_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1269 transport = container_of(xprt, struct sock_xprt, xprt);
1270 queue_delayed_work(rpciod_workqueue, &transport->connect_worker,
1271 timeout);
1274 static void xs_tcp_cancel_linger_timeout(struct rpc_xprt *xprt)
1276 struct sock_xprt *transport;
1278 transport = container_of(xprt, struct sock_xprt, xprt);
1280 if (!test_bit(XPRT_CONNECTION_ABORT, &xprt->state) ||
1281 !cancel_delayed_work(&transport->connect_worker))
1282 return;
1283 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1284 xprt_clear_connecting(xprt);
1287 static void xs_sock_mark_closed(struct rpc_xprt *xprt)
1289 smp_mb__before_clear_bit();
1290 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1291 clear_bit(XPRT_CLOSING, &xprt->state);
1292 smp_mb__after_clear_bit();
1293 /* Mark transport as closed and wake up all pending tasks */
1294 xprt_disconnect_done(xprt);
1298 * xs_tcp_state_change - callback to handle TCP socket state changes
1299 * @sk: socket whose state has changed
1302 static void xs_tcp_state_change(struct sock *sk)
1304 struct rpc_xprt *xprt;
1306 read_lock(&sk->sk_callback_lock);
1307 if (!(xprt = xprt_from_sock(sk)))
1308 goto out;
1309 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt);
1310 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n",
1311 sk->sk_state, xprt_connected(xprt),
1312 sock_flag(sk, SOCK_DEAD),
1313 sock_flag(sk, SOCK_ZAPPED),
1314 sk->sk_shutdown);
1316 switch (sk->sk_state) {
1317 case TCP_ESTABLISHED:
1318 spin_lock_bh(&xprt->transport_lock);
1319 if (!xprt_test_and_set_connected(xprt)) {
1320 struct sock_xprt *transport = container_of(xprt,
1321 struct sock_xprt, xprt);
1323 /* Reset TCP record info */
1324 transport->tcp_offset = 0;
1325 transport->tcp_reclen = 0;
1326 transport->tcp_copied = 0;
1327 transport->tcp_flags =
1328 TCP_RCV_COPY_FRAGHDR | TCP_RCV_COPY_XID;
1330 xprt_wake_pending_tasks(xprt, -EAGAIN);
1332 spin_unlock_bh(&xprt->transport_lock);
1333 break;
1334 case TCP_FIN_WAIT1:
1335 /* The client initiated a shutdown of the socket */
1336 xprt->connect_cookie++;
1337 xprt->reestablish_timeout = 0;
1338 set_bit(XPRT_CLOSING, &xprt->state);
1339 smp_mb__before_clear_bit();
1340 clear_bit(XPRT_CONNECTED, &xprt->state);
1341 clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
1342 smp_mb__after_clear_bit();
1343 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1344 break;
1345 case TCP_CLOSE_WAIT:
1346 /* The server initiated a shutdown of the socket */
1347 xprt_force_disconnect(xprt);
1348 xprt->connect_cookie++;
1349 case TCP_CLOSING:
1351 * If the server closed down the connection, make sure that
1352 * we back off before reconnecting
1354 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1355 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1356 break;
1357 case TCP_LAST_ACK:
1358 set_bit(XPRT_CLOSING, &xprt->state);
1359 xs_tcp_schedule_linger_timeout(xprt, xs_tcp_fin_timeout);
1360 smp_mb__before_clear_bit();
1361 clear_bit(XPRT_CONNECTED, &xprt->state);
1362 smp_mb__after_clear_bit();
1363 break;
1364 case TCP_CLOSE:
1365 xs_tcp_cancel_linger_timeout(xprt);
1366 xs_sock_mark_closed(xprt);
1368 out:
1369 read_unlock(&sk->sk_callback_lock);
1373 * xs_error_report - callback mainly for catching socket errors
1374 * @sk: socket
1376 static void xs_error_report(struct sock *sk)
1378 struct rpc_xprt *xprt;
1380 read_lock(&sk->sk_callback_lock);
1381 if (!(xprt = xprt_from_sock(sk)))
1382 goto out;
1383 dprintk("RPC: %s client %p...\n"
1384 "RPC: error %d\n",
1385 __func__, xprt, sk->sk_err);
1386 xprt_wake_pending_tasks(xprt, -EAGAIN);
1387 out:
1388 read_unlock(&sk->sk_callback_lock);
1391 static void xs_write_space(struct sock *sk)
1393 struct socket *sock;
1394 struct rpc_xprt *xprt;
1396 if (unlikely(!(sock = sk->sk_socket)))
1397 return;
1398 clear_bit(SOCK_NOSPACE, &sock->flags);
1400 if (unlikely(!(xprt = xprt_from_sock(sk))))
1401 return;
1402 if (test_and_clear_bit(SOCK_ASYNC_NOSPACE, &sock->flags) == 0)
1403 return;
1405 xprt_write_space(xprt);
1409 * xs_udp_write_space - callback invoked when socket buffer space
1410 * becomes available
1411 * @sk: socket whose state has changed
1413 * Called when more output buffer space is available for this socket.
1414 * We try not to wake our writers until they can make "significant"
1415 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1416 * with a bunch of small requests.
1418 static void xs_udp_write_space(struct sock *sk)
1420 read_lock(&sk->sk_callback_lock);
1422 /* from net/core/sock.c:sock_def_write_space */
1423 if (sock_writeable(sk))
1424 xs_write_space(sk);
1426 read_unlock(&sk->sk_callback_lock);
1430 * xs_tcp_write_space - callback invoked when socket buffer space
1431 * becomes available
1432 * @sk: socket whose state has changed
1434 * Called when more output buffer space is available for this socket.
1435 * We try not to wake our writers until they can make "significant"
1436 * progress, otherwise we'll waste resources thrashing kernel_sendmsg
1437 * with a bunch of small requests.
1439 static void xs_tcp_write_space(struct sock *sk)
1441 read_lock(&sk->sk_callback_lock);
1443 /* from net/core/stream.c:sk_stream_write_space */
1444 if (sk_stream_wspace(sk) >= sk_stream_min_wspace(sk))
1445 xs_write_space(sk);
1447 read_unlock(&sk->sk_callback_lock);
1450 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt)
1452 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1453 struct sock *sk = transport->inet;
1455 if (transport->rcvsize) {
1456 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
1457 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2;
1459 if (transport->sndsize) {
1460 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
1461 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2;
1462 sk->sk_write_space(sk);
1467 * xs_udp_set_buffer_size - set send and receive limits
1468 * @xprt: generic transport
1469 * @sndsize: requested size of send buffer, in bytes
1470 * @rcvsize: requested size of receive buffer, in bytes
1472 * Set socket send and receive buffer size limits.
1474 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize)
1476 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1478 transport->sndsize = 0;
1479 if (sndsize)
1480 transport->sndsize = sndsize + 1024;
1481 transport->rcvsize = 0;
1482 if (rcvsize)
1483 transport->rcvsize = rcvsize + 1024;
1485 xs_udp_do_set_buffer_size(xprt);
1489 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
1490 * @task: task that timed out
1492 * Adjust the congestion window after a retransmit timeout has occurred.
1494 static void xs_udp_timer(struct rpc_task *task)
1496 xprt_adjust_cwnd(task, -ETIMEDOUT);
1499 static unsigned short xs_get_random_port(void)
1501 unsigned short range = xprt_max_resvport - xprt_min_resvport;
1502 unsigned short rand = (unsigned short) net_random() % range;
1503 return rand + xprt_min_resvport;
1507 * xs_set_port - reset the port number in the remote endpoint address
1508 * @xprt: generic transport
1509 * @port: new port number
1512 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port)
1514 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port);
1516 rpc_set_port(xs_addr(xprt), port);
1517 xs_update_peer_port(xprt);
1520 static unsigned short xs_get_srcport(struct sock_xprt *transport, struct socket *sock)
1522 unsigned short port = transport->srcport;
1524 if (port == 0 && transport->xprt.resvport)
1525 port = xs_get_random_port();
1526 return port;
1529 static unsigned short xs_next_srcport(struct sock_xprt *transport, struct socket *sock, unsigned short port)
1531 if (transport->srcport != 0)
1532 transport->srcport = 0;
1533 if (!transport->xprt.resvport)
1534 return 0;
1535 if (port <= xprt_min_resvport || port > xprt_max_resvport)
1536 return xprt_max_resvport;
1537 return --port;
1540 static int xs_bind4(struct sock_xprt *transport, struct socket *sock)
1542 struct sockaddr_in myaddr = {
1543 .sin_family = AF_INET,
1545 struct sockaddr_in *sa;
1546 int err, nloop = 0;
1547 unsigned short port = xs_get_srcport(transport, sock);
1548 unsigned short last;
1550 sa = (struct sockaddr_in *)&transport->srcaddr;
1551 myaddr.sin_addr = sa->sin_addr;
1552 do {
1553 myaddr.sin_port = htons(port);
1554 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1555 sizeof(myaddr));
1556 if (port == 0)
1557 break;
1558 if (err == 0) {
1559 transport->srcport = port;
1560 break;
1562 last = port;
1563 port = xs_next_srcport(transport, sock, port);
1564 if (port > last)
1565 nloop++;
1566 } while (err == -EADDRINUSE && nloop != 2);
1567 dprintk("RPC: %s %pI4:%u: %s (%d)\n",
1568 __func__, &myaddr.sin_addr,
1569 port, err ? "failed" : "ok", err);
1570 return err;
1573 static int xs_bind6(struct sock_xprt *transport, struct socket *sock)
1575 struct sockaddr_in6 myaddr = {
1576 .sin6_family = AF_INET6,
1578 struct sockaddr_in6 *sa;
1579 int err, nloop = 0;
1580 unsigned short port = xs_get_srcport(transport, sock);
1581 unsigned short last;
1583 sa = (struct sockaddr_in6 *)&transport->srcaddr;
1584 myaddr.sin6_addr = sa->sin6_addr;
1585 do {
1586 myaddr.sin6_port = htons(port);
1587 err = kernel_bind(sock, (struct sockaddr *) &myaddr,
1588 sizeof(myaddr));
1589 if (port == 0)
1590 break;
1591 if (err == 0) {
1592 transport->srcport = port;
1593 break;
1595 last = port;
1596 port = xs_next_srcport(transport, sock, port);
1597 if (port > last)
1598 nloop++;
1599 } while (err == -EADDRINUSE && nloop != 2);
1600 dprintk("RPC: xs_bind6 %pI6:%u: %s (%d)\n",
1601 &myaddr.sin6_addr, port, err ? "failed" : "ok", err);
1602 return err;
1605 #ifdef CONFIG_DEBUG_LOCK_ALLOC
1606 static struct lock_class_key xs_key[2];
1607 static struct lock_class_key xs_slock_key[2];
1609 static inline void xs_reclassify_socket4(struct socket *sock)
1611 struct sock *sk = sock->sk;
1613 BUG_ON(sock_owned_by_user(sk));
1614 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC",
1615 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]);
1618 static inline void xs_reclassify_socket6(struct socket *sock)
1620 struct sock *sk = sock->sk;
1622 BUG_ON(sock_owned_by_user(sk));
1623 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC",
1624 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]);
1626 #else
1627 static inline void xs_reclassify_socket4(struct socket *sock)
1631 static inline void xs_reclassify_socket6(struct socket *sock)
1634 #endif
1636 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1638 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1640 if (!transport->inet) {
1641 struct sock *sk = sock->sk;
1643 write_lock_bh(&sk->sk_callback_lock);
1645 xs_save_old_callbacks(transport, sk);
1647 sk->sk_user_data = xprt;
1648 sk->sk_data_ready = xs_udp_data_ready;
1649 sk->sk_write_space = xs_udp_write_space;
1650 sk->sk_error_report = xs_error_report;
1651 sk->sk_no_check = UDP_CSUM_NORCV;
1652 sk->sk_allocation = GFP_ATOMIC;
1654 xprt_set_connected(xprt);
1656 /* Reset to new socket */
1657 transport->sock = sock;
1658 transport->inet = sk;
1660 write_unlock_bh(&sk->sk_callback_lock);
1662 xs_udp_do_set_buffer_size(xprt);
1666 * xs_udp_connect_worker4 - set up a UDP socket
1667 * @work: RPC transport to connect
1669 * Invoked by a work queue tasklet.
1671 static void xs_udp_connect_worker4(struct work_struct *work)
1673 struct sock_xprt *transport =
1674 container_of(work, struct sock_xprt, connect_worker.work);
1675 struct rpc_xprt *xprt = &transport->xprt;
1676 struct socket *sock = transport->sock;
1677 int err, status = -EIO;
1679 if (xprt->shutdown)
1680 goto out;
1682 /* Start by resetting any existing state */
1683 xs_reset_transport(transport);
1685 err = sock_create_kern(PF_INET, SOCK_DGRAM, IPPROTO_UDP, &sock);
1686 if (err < 0) {
1687 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1688 goto out;
1690 xs_reclassify_socket4(sock);
1692 if (xs_bind4(transport, sock)) {
1693 sock_release(sock);
1694 goto out;
1697 dprintk("RPC: worker connecting xprt %p via %s to "
1698 "%s (port %s)\n", xprt,
1699 xprt->address_strings[RPC_DISPLAY_PROTO],
1700 xprt->address_strings[RPC_DISPLAY_ADDR],
1701 xprt->address_strings[RPC_DISPLAY_PORT]);
1703 xs_udp_finish_connecting(xprt, sock);
1704 status = 0;
1705 out:
1706 xprt_clear_connecting(xprt);
1707 xprt_wake_pending_tasks(xprt, status);
1711 * xs_udp_connect_worker6 - set up a UDP socket
1712 * @work: RPC transport to connect
1714 * Invoked by a work queue tasklet.
1716 static void xs_udp_connect_worker6(struct work_struct *work)
1718 struct sock_xprt *transport =
1719 container_of(work, struct sock_xprt, connect_worker.work);
1720 struct rpc_xprt *xprt = &transport->xprt;
1721 struct socket *sock = transport->sock;
1722 int err, status = -EIO;
1724 if (xprt->shutdown)
1725 goto out;
1727 /* Start by resetting any existing state */
1728 xs_reset_transport(transport);
1730 err = sock_create_kern(PF_INET6, SOCK_DGRAM, IPPROTO_UDP, &sock);
1731 if (err < 0) {
1732 dprintk("RPC: can't create UDP transport socket (%d).\n", -err);
1733 goto out;
1735 xs_reclassify_socket6(sock);
1737 if (xs_bind6(transport, sock) < 0) {
1738 sock_release(sock);
1739 goto out;
1742 dprintk("RPC: worker connecting xprt %p via %s to "
1743 "%s (port %s)\n", xprt,
1744 xprt->address_strings[RPC_DISPLAY_PROTO],
1745 xprt->address_strings[RPC_DISPLAY_ADDR],
1746 xprt->address_strings[RPC_DISPLAY_PORT]);
1748 xs_udp_finish_connecting(xprt, sock);
1749 status = 0;
1750 out:
1751 xprt_clear_connecting(xprt);
1752 xprt_wake_pending_tasks(xprt, status);
1756 * We need to preserve the port number so the reply cache on the server can
1757 * find our cached RPC replies when we get around to reconnecting.
1759 static void xs_abort_connection(struct rpc_xprt *xprt, struct sock_xprt *transport)
1761 int result;
1762 struct sockaddr any;
1764 dprintk("RPC: disconnecting xprt %p to reuse port\n", xprt);
1767 * Disconnect the transport socket by doing a connect operation
1768 * with AF_UNSPEC. This should return immediately...
1770 memset(&any, 0, sizeof(any));
1771 any.sa_family = AF_UNSPEC;
1772 result = kernel_connect(transport->sock, &any, sizeof(any), 0);
1773 if (!result)
1774 xs_sock_mark_closed(xprt);
1775 else
1776 dprintk("RPC: AF_UNSPEC connect return code %d\n",
1777 result);
1780 static void xs_tcp_reuse_connection(struct rpc_xprt *xprt, struct sock_xprt *transport)
1782 unsigned int state = transport->inet->sk_state;
1784 if (state == TCP_CLOSE && transport->sock->state == SS_UNCONNECTED) {
1785 /* we don't need to abort the connection if the socket
1786 * hasn't undergone a shutdown
1788 if (transport->inet->sk_shutdown == 0)
1789 return;
1790 dprintk("RPC: %s: TCP_CLOSEd and sk_shutdown set to %d\n",
1791 __func__, transport->inet->sk_shutdown);
1793 if ((1 << state) & (TCPF_ESTABLISHED|TCPF_SYN_SENT)) {
1794 /* we don't need to abort the connection if the socket
1795 * hasn't undergone a shutdown
1797 if (transport->inet->sk_shutdown == 0)
1798 return;
1799 dprintk("RPC: %s: ESTABLISHED/SYN_SENT "
1800 "sk_shutdown set to %d\n",
1801 __func__, transport->inet->sk_shutdown);
1803 xs_abort_connection(xprt, transport);
1806 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock)
1808 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
1809 int ret = -ENOTCONN;
1811 if (!transport->inet) {
1812 struct sock *sk = sock->sk;
1814 write_lock_bh(&sk->sk_callback_lock);
1816 xs_save_old_callbacks(transport, sk);
1818 sk->sk_user_data = xprt;
1819 sk->sk_data_ready = xs_tcp_data_ready;
1820 sk->sk_state_change = xs_tcp_state_change;
1821 sk->sk_write_space = xs_tcp_write_space;
1822 sk->sk_error_report = xs_error_report;
1823 sk->sk_allocation = GFP_ATOMIC;
1825 /* socket options */
1826 sk->sk_userlocks |= SOCK_BINDPORT_LOCK;
1827 sock_reset_flag(sk, SOCK_LINGER);
1828 tcp_sk(sk)->linger2 = 0;
1829 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF;
1831 xprt_clear_connected(xprt);
1833 /* Reset to new socket */
1834 transport->sock = sock;
1835 transport->inet = sk;
1837 write_unlock_bh(&sk->sk_callback_lock);
1840 if (!xprt_bound(xprt))
1841 goto out;
1843 /* Tell the socket layer to start connecting... */
1844 xprt->stat.connect_count++;
1845 xprt->stat.connect_start = jiffies;
1846 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK);
1847 switch (ret) {
1848 case 0:
1849 case -EINPROGRESS:
1850 /* SYN_SENT! */
1851 xprt->connect_cookie++;
1852 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
1853 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
1855 out:
1856 return ret;
1860 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
1861 * @xprt: RPC transport to connect
1862 * @transport: socket transport to connect
1863 * @create_sock: function to create a socket of the correct type
1865 * Invoked by a work queue tasklet.
1867 static void xs_tcp_setup_socket(struct rpc_xprt *xprt,
1868 struct sock_xprt *transport,
1869 struct socket *(*create_sock)(struct rpc_xprt *,
1870 struct sock_xprt *))
1872 struct socket *sock = transport->sock;
1873 int status = -EIO;
1875 if (xprt->shutdown)
1876 goto out;
1878 if (!sock) {
1879 clear_bit(XPRT_CONNECTION_ABORT, &xprt->state);
1880 sock = create_sock(xprt, transport);
1881 if (IS_ERR(sock)) {
1882 status = PTR_ERR(sock);
1883 goto out;
1885 } else {
1886 int abort_and_exit;
1888 abort_and_exit = test_and_clear_bit(XPRT_CONNECTION_ABORT,
1889 &xprt->state);
1890 /* "close" the socket, preserving the local port */
1891 xs_tcp_reuse_connection(xprt, transport);
1893 if (abort_and_exit)
1894 goto out_eagain;
1897 dprintk("RPC: worker connecting xprt %p via %s to "
1898 "%s (port %s)\n", xprt,
1899 xprt->address_strings[RPC_DISPLAY_PROTO],
1900 xprt->address_strings[RPC_DISPLAY_ADDR],
1901 xprt->address_strings[RPC_DISPLAY_PORT]);
1903 status = xs_tcp_finish_connecting(xprt, sock);
1904 dprintk("RPC: %p connect status %d connected %d sock state %d\n",
1905 xprt, -status, xprt_connected(xprt),
1906 sock->sk->sk_state);
1907 switch (status) {
1908 default:
1909 printk("%s: connect returned unhandled error %d\n",
1910 __func__, status);
1911 case -EADDRNOTAVAIL:
1912 /* We're probably in TIME_WAIT. Get rid of existing socket,
1913 * and retry
1915 set_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
1916 xprt_force_disconnect(xprt);
1917 break;
1918 case -ECONNREFUSED:
1919 case -ECONNRESET:
1920 case -ENETUNREACH:
1921 /* retry with existing socket, after a delay */
1922 case 0:
1923 case -EINPROGRESS:
1924 case -EALREADY:
1925 xprt_clear_connecting(xprt);
1926 return;
1927 case -EINVAL:
1928 /* Happens, for instance, if the user specified a link
1929 * local IPv6 address without a scope-id.
1931 goto out;
1933 out_eagain:
1934 status = -EAGAIN;
1935 out:
1936 xprt_clear_connecting(xprt);
1937 xprt_wake_pending_tasks(xprt, status);
1940 static struct socket *xs_create_tcp_sock4(struct rpc_xprt *xprt,
1941 struct sock_xprt *transport)
1943 struct socket *sock;
1944 int err;
1946 /* start from scratch */
1947 err = sock_create_kern(PF_INET, SOCK_STREAM, IPPROTO_TCP, &sock);
1948 if (err < 0) {
1949 dprintk("RPC: can't create TCP transport socket (%d).\n",
1950 -err);
1951 goto out_err;
1953 xs_reclassify_socket4(sock);
1955 if (xs_bind4(transport, sock) < 0) {
1956 sock_release(sock);
1957 goto out_err;
1959 return sock;
1960 out_err:
1961 return ERR_PTR(-EIO);
1965 * xs_tcp_connect_worker4 - connect a TCP socket to a remote endpoint
1966 * @work: RPC transport to connect
1968 * Invoked by a work queue tasklet.
1970 static void xs_tcp_connect_worker4(struct work_struct *work)
1972 struct sock_xprt *transport =
1973 container_of(work, struct sock_xprt, connect_worker.work);
1974 struct rpc_xprt *xprt = &transport->xprt;
1976 xs_tcp_setup_socket(xprt, transport, xs_create_tcp_sock4);
1979 static struct socket *xs_create_tcp_sock6(struct rpc_xprt *xprt,
1980 struct sock_xprt *transport)
1982 struct socket *sock;
1983 int err;
1985 /* start from scratch */
1986 err = sock_create_kern(PF_INET6, SOCK_STREAM, IPPROTO_TCP, &sock);
1987 if (err < 0) {
1988 dprintk("RPC: can't create TCP transport socket (%d).\n",
1989 -err);
1990 goto out_err;
1992 xs_reclassify_socket6(sock);
1994 if (xs_bind6(transport, sock) < 0) {
1995 sock_release(sock);
1996 goto out_err;
1998 return sock;
1999 out_err:
2000 return ERR_PTR(-EIO);
2004 * xs_tcp_connect_worker6 - connect a TCP socket to a remote endpoint
2005 * @work: RPC transport to connect
2007 * Invoked by a work queue tasklet.
2009 static void xs_tcp_connect_worker6(struct work_struct *work)
2011 struct sock_xprt *transport =
2012 container_of(work, struct sock_xprt, connect_worker.work);
2013 struct rpc_xprt *xprt = &transport->xprt;
2015 xs_tcp_setup_socket(xprt, transport, xs_create_tcp_sock6);
2019 * xs_connect - connect a socket to a remote endpoint
2020 * @task: address of RPC task that manages state of connect request
2022 * TCP: If the remote end dropped the connection, delay reconnecting.
2024 * UDP socket connects are synchronous, but we use a work queue anyway
2025 * to guarantee that even unprivileged user processes can set up a
2026 * socket on a privileged port.
2028 * If a UDP socket connect fails, the delay behavior here prevents
2029 * retry floods (hard mounts).
2031 static void xs_connect(struct rpc_task *task)
2033 struct rpc_xprt *xprt = task->tk_xprt;
2034 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2036 if (transport->sock != NULL && !RPC_IS_SOFTCONN(task)) {
2037 dprintk("RPC: xs_connect delayed xprt %p for %lu "
2038 "seconds\n",
2039 xprt, xprt->reestablish_timeout / HZ);
2040 queue_delayed_work(rpciod_workqueue,
2041 &transport->connect_worker,
2042 xprt->reestablish_timeout);
2043 xprt->reestablish_timeout <<= 1;
2044 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO)
2045 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2046 if (xprt->reestablish_timeout > XS_TCP_MAX_REEST_TO)
2047 xprt->reestablish_timeout = XS_TCP_MAX_REEST_TO;
2048 } else {
2049 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt);
2050 queue_delayed_work(rpciod_workqueue,
2051 &transport->connect_worker, 0);
2056 * xs_udp_print_stats - display UDP socket-specifc stats
2057 * @xprt: rpc_xprt struct containing statistics
2058 * @seq: output file
2061 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2063 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2065 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %Lu %Lu\n",
2066 transport->srcport,
2067 xprt->stat.bind_count,
2068 xprt->stat.sends,
2069 xprt->stat.recvs,
2070 xprt->stat.bad_xids,
2071 xprt->stat.req_u,
2072 xprt->stat.bklog_u);
2076 * xs_tcp_print_stats - display TCP socket-specifc stats
2077 * @xprt: rpc_xprt struct containing statistics
2078 * @seq: output file
2081 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq)
2083 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt);
2084 long idle_time = 0;
2086 if (xprt_connected(xprt))
2087 idle_time = (long)(jiffies - xprt->last_used) / HZ;
2089 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu %Lu %Lu\n",
2090 transport->srcport,
2091 xprt->stat.bind_count,
2092 xprt->stat.connect_count,
2093 xprt->stat.connect_time,
2094 idle_time,
2095 xprt->stat.sends,
2096 xprt->stat.recvs,
2097 xprt->stat.bad_xids,
2098 xprt->stat.req_u,
2099 xprt->stat.bklog_u);
2103 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason
2104 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want
2105 * to use the server side send routines.
2107 static void *bc_malloc(struct rpc_task *task, size_t size)
2109 struct page *page;
2110 struct rpc_buffer *buf;
2112 BUG_ON(size > PAGE_SIZE - sizeof(struct rpc_buffer));
2113 page = alloc_page(GFP_KERNEL);
2115 if (!page)
2116 return NULL;
2118 buf = page_address(page);
2119 buf->len = PAGE_SIZE;
2121 return buf->data;
2125 * Free the space allocated in the bc_alloc routine
2127 static void bc_free(void *buffer)
2129 struct rpc_buffer *buf;
2131 if (!buffer)
2132 return;
2134 buf = container_of(buffer, struct rpc_buffer, data);
2135 free_page((unsigned long)buf);
2139 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex
2140 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request.
2142 static int bc_sendto(struct rpc_rqst *req)
2144 int len;
2145 struct xdr_buf *xbufp = &req->rq_snd_buf;
2146 struct rpc_xprt *xprt = req->rq_xprt;
2147 struct sock_xprt *transport =
2148 container_of(xprt, struct sock_xprt, xprt);
2149 struct socket *sock = transport->sock;
2150 unsigned long headoff;
2151 unsigned long tailoff;
2154 * Set up the rpc header and record marker stuff
2156 xs_encode_tcp_record_marker(xbufp);
2158 tailoff = (unsigned long)xbufp->tail[0].iov_base & ~PAGE_MASK;
2159 headoff = (unsigned long)xbufp->head[0].iov_base & ~PAGE_MASK;
2160 len = svc_send_common(sock, xbufp,
2161 virt_to_page(xbufp->head[0].iov_base), headoff,
2162 xbufp->tail[0].iov_base, tailoff);
2164 if (len != xbufp->len) {
2165 printk(KERN_NOTICE "Error sending entire callback!\n");
2166 len = -EAGAIN;
2169 return len;
2173 * The send routine. Borrows from svc_send
2175 static int bc_send_request(struct rpc_task *task)
2177 struct rpc_rqst *req = task->tk_rqstp;
2178 struct svc_xprt *xprt;
2179 struct svc_sock *svsk;
2180 u32 len;
2182 dprintk("sending request with xid: %08x\n", ntohl(req->rq_xid));
2184 * Get the server socket associated with this callback xprt
2186 xprt = req->rq_xprt->bc_xprt;
2187 svsk = container_of(xprt, struct svc_sock, sk_xprt);
2190 * Grab the mutex to serialize data as the connection is shared
2191 * with the fore channel
2193 if (!mutex_trylock(&xprt->xpt_mutex)) {
2194 rpc_sleep_on(&xprt->xpt_bc_pending, task, NULL);
2195 if (!mutex_trylock(&xprt->xpt_mutex))
2196 return -EAGAIN;
2197 rpc_wake_up_queued_task(&xprt->xpt_bc_pending, task);
2199 if (test_bit(XPT_DEAD, &xprt->xpt_flags))
2200 len = -ENOTCONN;
2201 else
2202 len = bc_sendto(req);
2203 mutex_unlock(&xprt->xpt_mutex);
2205 if (len > 0)
2206 len = 0;
2208 return len;
2212 * The close routine. Since this is client initiated, we do nothing
2215 static void bc_close(struct rpc_xprt *xprt)
2220 * The xprt destroy routine. Again, because this connection is client
2221 * initiated, we do nothing
2224 static void bc_destroy(struct rpc_xprt *xprt)
2228 static struct rpc_xprt_ops xs_udp_ops = {
2229 .set_buffer_size = xs_udp_set_buffer_size,
2230 .reserve_xprt = xprt_reserve_xprt_cong,
2231 .release_xprt = xprt_release_xprt_cong,
2232 .rpcbind = rpcb_getport_async,
2233 .set_port = xs_set_port,
2234 .connect = xs_connect,
2235 .buf_alloc = rpc_malloc,
2236 .buf_free = rpc_free,
2237 .send_request = xs_udp_send_request,
2238 .set_retrans_timeout = xprt_set_retrans_timeout_rtt,
2239 .timer = xs_udp_timer,
2240 .release_request = xprt_release_rqst_cong,
2241 .close = xs_close,
2242 .destroy = xs_destroy,
2243 .print_stats = xs_udp_print_stats,
2246 static struct rpc_xprt_ops xs_tcp_ops = {
2247 .reserve_xprt = xprt_reserve_xprt,
2248 .release_xprt = xs_tcp_release_xprt,
2249 .rpcbind = rpcb_getport_async,
2250 .set_port = xs_set_port,
2251 .connect = xs_connect,
2252 .buf_alloc = rpc_malloc,
2253 .buf_free = rpc_free,
2254 .send_request = xs_tcp_send_request,
2255 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2256 .close = xs_tcp_close,
2257 .destroy = xs_destroy,
2258 .print_stats = xs_tcp_print_stats,
2262 * The rpc_xprt_ops for the server backchannel
2265 static struct rpc_xprt_ops bc_tcp_ops = {
2266 .reserve_xprt = xprt_reserve_xprt,
2267 .release_xprt = xprt_release_xprt,
2268 .buf_alloc = bc_malloc,
2269 .buf_free = bc_free,
2270 .send_request = bc_send_request,
2271 .set_retrans_timeout = xprt_set_retrans_timeout_def,
2272 .close = bc_close,
2273 .destroy = bc_destroy,
2274 .print_stats = xs_tcp_print_stats,
2277 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args,
2278 unsigned int slot_table_size)
2280 struct rpc_xprt *xprt;
2281 struct sock_xprt *new;
2283 if (args->addrlen > sizeof(xprt->addr)) {
2284 dprintk("RPC: xs_setup_xprt: address too large\n");
2285 return ERR_PTR(-EBADF);
2288 new = kzalloc(sizeof(*new), GFP_KERNEL);
2289 if (new == NULL) {
2290 dprintk("RPC: xs_setup_xprt: couldn't allocate "
2291 "rpc_xprt\n");
2292 return ERR_PTR(-ENOMEM);
2294 xprt = &new->xprt;
2296 xprt->max_reqs = slot_table_size;
2297 xprt->slot = kcalloc(xprt->max_reqs, sizeof(struct rpc_rqst), GFP_KERNEL);
2298 if (xprt->slot == NULL) {
2299 kfree(xprt);
2300 dprintk("RPC: xs_setup_xprt: couldn't allocate slot "
2301 "table\n");
2302 return ERR_PTR(-ENOMEM);
2305 memcpy(&xprt->addr, args->dstaddr, args->addrlen);
2306 xprt->addrlen = args->addrlen;
2307 if (args->srcaddr)
2308 memcpy(&new->srcaddr, args->srcaddr, args->addrlen);
2310 return xprt;
2313 static const struct rpc_timeout xs_udp_default_timeout = {
2314 .to_initval = 5 * HZ,
2315 .to_maxval = 30 * HZ,
2316 .to_increment = 5 * HZ,
2317 .to_retries = 5,
2321 * xs_setup_udp - Set up transport to use a UDP socket
2322 * @args: rpc transport creation arguments
2325 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args)
2327 struct sockaddr *addr = args->dstaddr;
2328 struct rpc_xprt *xprt;
2329 struct sock_xprt *transport;
2330 struct rpc_xprt *ret;
2332 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries);
2333 if (IS_ERR(xprt))
2334 return xprt;
2335 transport = container_of(xprt, struct sock_xprt, xprt);
2337 xprt->prot = IPPROTO_UDP;
2338 xprt->tsh_size = 0;
2339 /* XXX: header size can vary due to auth type, IPv6, etc. */
2340 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3);
2342 xprt->bind_timeout = XS_BIND_TO;
2343 xprt->reestablish_timeout = XS_UDP_REEST_TO;
2344 xprt->idle_timeout = XS_IDLE_DISC_TO;
2346 xprt->ops = &xs_udp_ops;
2348 xprt->timeout = &xs_udp_default_timeout;
2350 switch (addr->sa_family) {
2351 case AF_INET:
2352 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2353 xprt_set_bound(xprt);
2355 INIT_DELAYED_WORK(&transport->connect_worker,
2356 xs_udp_connect_worker4);
2357 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP);
2358 break;
2359 case AF_INET6:
2360 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2361 xprt_set_bound(xprt);
2363 INIT_DELAYED_WORK(&transport->connect_worker,
2364 xs_udp_connect_worker6);
2365 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6);
2366 break;
2367 default:
2368 ret = ERR_PTR(-EAFNOSUPPORT);
2369 goto out_err;
2372 if (xprt_bound(xprt))
2373 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2374 xprt->address_strings[RPC_DISPLAY_ADDR],
2375 xprt->address_strings[RPC_DISPLAY_PORT],
2376 xprt->address_strings[RPC_DISPLAY_PROTO]);
2377 else
2378 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2379 xprt->address_strings[RPC_DISPLAY_ADDR],
2380 xprt->address_strings[RPC_DISPLAY_PROTO]);
2382 if (try_module_get(THIS_MODULE))
2383 return xprt;
2384 ret = ERR_PTR(-EINVAL);
2385 out_err:
2386 kfree(xprt->slot);
2387 kfree(xprt);
2388 return ret;
2391 static const struct rpc_timeout xs_tcp_default_timeout = {
2392 .to_initval = 60 * HZ,
2393 .to_maxval = 60 * HZ,
2394 .to_retries = 2,
2398 * xs_setup_tcp - Set up transport to use a TCP socket
2399 * @args: rpc transport creation arguments
2402 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args)
2404 struct sockaddr *addr = args->dstaddr;
2405 struct rpc_xprt *xprt;
2406 struct sock_xprt *transport;
2407 struct rpc_xprt *ret;
2409 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries);
2410 if (IS_ERR(xprt))
2411 return xprt;
2412 transport = container_of(xprt, struct sock_xprt, xprt);
2414 xprt->prot = IPPROTO_TCP;
2415 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2416 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2418 xprt->bind_timeout = XS_BIND_TO;
2419 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO;
2420 xprt->idle_timeout = XS_IDLE_DISC_TO;
2422 xprt->ops = &xs_tcp_ops;
2423 xprt->timeout = &xs_tcp_default_timeout;
2425 switch (addr->sa_family) {
2426 case AF_INET:
2427 if (((struct sockaddr_in *)addr)->sin_port != htons(0))
2428 xprt_set_bound(xprt);
2430 INIT_DELAYED_WORK(&transport->connect_worker,
2431 xs_tcp_connect_worker4);
2432 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP);
2433 break;
2434 case AF_INET6:
2435 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0))
2436 xprt_set_bound(xprt);
2438 INIT_DELAYED_WORK(&transport->connect_worker,
2439 xs_tcp_connect_worker6);
2440 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6);
2441 break;
2442 default:
2443 ret = ERR_PTR(-EAFNOSUPPORT);
2444 goto out_err;
2447 if (xprt_bound(xprt))
2448 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2449 xprt->address_strings[RPC_DISPLAY_ADDR],
2450 xprt->address_strings[RPC_DISPLAY_PORT],
2451 xprt->address_strings[RPC_DISPLAY_PROTO]);
2452 else
2453 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2454 xprt->address_strings[RPC_DISPLAY_ADDR],
2455 xprt->address_strings[RPC_DISPLAY_PROTO]);
2458 if (try_module_get(THIS_MODULE))
2459 return xprt;
2460 ret = ERR_PTR(-EINVAL);
2461 out_err:
2462 kfree(xprt->slot);
2463 kfree(xprt);
2464 return ret;
2468 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket
2469 * @args: rpc transport creation arguments
2472 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args)
2474 struct sockaddr *addr = args->dstaddr;
2475 struct rpc_xprt *xprt;
2476 struct sock_xprt *transport;
2477 struct svc_sock *bc_sock;
2478 struct rpc_xprt *ret;
2480 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries);
2481 if (IS_ERR(xprt))
2482 return xprt;
2483 transport = container_of(xprt, struct sock_xprt, xprt);
2485 xprt->prot = IPPROTO_TCP;
2486 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32);
2487 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE;
2488 xprt->timeout = &xs_tcp_default_timeout;
2490 /* backchannel */
2491 xprt_set_bound(xprt);
2492 xprt->bind_timeout = 0;
2493 xprt->reestablish_timeout = 0;
2494 xprt->idle_timeout = 0;
2497 * The backchannel uses the same socket connection as the
2498 * forechannel
2500 xprt->bc_xprt = args->bc_xprt;
2501 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt);
2502 bc_sock->sk_bc_xprt = xprt;
2503 transport->sock = bc_sock->sk_sock;
2504 transport->inet = bc_sock->sk_sk;
2506 xprt->ops = &bc_tcp_ops;
2508 switch (addr->sa_family) {
2509 case AF_INET:
2510 xs_format_peer_addresses(xprt, "tcp",
2511 RPCBIND_NETID_TCP);
2512 break;
2513 case AF_INET6:
2514 xs_format_peer_addresses(xprt, "tcp",
2515 RPCBIND_NETID_TCP6);
2516 break;
2517 default:
2518 ret = ERR_PTR(-EAFNOSUPPORT);
2519 goto out_err;
2522 if (xprt_bound(xprt))
2523 dprintk("RPC: set up xprt to %s (port %s) via %s\n",
2524 xprt->address_strings[RPC_DISPLAY_ADDR],
2525 xprt->address_strings[RPC_DISPLAY_PORT],
2526 xprt->address_strings[RPC_DISPLAY_PROTO]);
2527 else
2528 dprintk("RPC: set up xprt to %s (autobind) via %s\n",
2529 xprt->address_strings[RPC_DISPLAY_ADDR],
2530 xprt->address_strings[RPC_DISPLAY_PROTO]);
2533 * Since we don't want connections for the backchannel, we set
2534 * the xprt status to connected
2536 xprt_set_connected(xprt);
2539 if (try_module_get(THIS_MODULE))
2540 return xprt;
2541 ret = ERR_PTR(-EINVAL);
2542 out_err:
2543 kfree(xprt->slot);
2544 kfree(xprt);
2545 return ret;
2548 static struct xprt_class xs_udp_transport = {
2549 .list = LIST_HEAD_INIT(xs_udp_transport.list),
2550 .name = "udp",
2551 .owner = THIS_MODULE,
2552 .ident = XPRT_TRANSPORT_UDP,
2553 .setup = xs_setup_udp,
2556 static struct xprt_class xs_tcp_transport = {
2557 .list = LIST_HEAD_INIT(xs_tcp_transport.list),
2558 .name = "tcp",
2559 .owner = THIS_MODULE,
2560 .ident = XPRT_TRANSPORT_TCP,
2561 .setup = xs_setup_tcp,
2564 static struct xprt_class xs_bc_tcp_transport = {
2565 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list),
2566 .name = "tcp NFSv4.1 backchannel",
2567 .owner = THIS_MODULE,
2568 .ident = XPRT_TRANSPORT_BC_TCP,
2569 .setup = xs_setup_bc_tcp,
2573 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client
2576 int init_socket_xprt(void)
2578 #ifdef RPC_DEBUG
2579 if (!sunrpc_table_header)
2580 sunrpc_table_header = register_sysctl_table(sunrpc_table);
2581 #endif
2583 xprt_register_transport(&xs_udp_transport);
2584 xprt_register_transport(&xs_tcp_transport);
2585 xprt_register_transport(&xs_bc_tcp_transport);
2587 return 0;
2591 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister
2594 void cleanup_socket_xprt(void)
2596 #ifdef RPC_DEBUG
2597 if (sunrpc_table_header) {
2598 unregister_sysctl_table(sunrpc_table_header);
2599 sunrpc_table_header = NULL;
2601 #endif
2603 xprt_unregister_transport(&xs_udp_transport);
2604 xprt_unregister_transport(&xs_tcp_transport);
2605 xprt_unregister_transport(&xs_bc_tcp_transport);
2608 static int param_set_uint_minmax(const char *val, struct kernel_param *kp,
2609 unsigned int min, unsigned int max)
2611 unsigned long num;
2612 int ret;
2614 if (!val)
2615 return -EINVAL;
2616 ret = strict_strtoul(val, 0, &num);
2617 if (ret == -EINVAL || num < min || num > max)
2618 return -EINVAL;
2619 *((unsigned int *)kp->arg) = num;
2620 return 0;
2623 static int param_set_portnr(const char *val, struct kernel_param *kp)
2625 return param_set_uint_minmax(val, kp,
2626 RPC_MIN_RESVPORT,
2627 RPC_MAX_RESVPORT);
2630 static int param_get_portnr(char *buffer, struct kernel_param *kp)
2632 return param_get_uint(buffer, kp);
2634 #define param_check_portnr(name, p) \
2635 __param_check(name, p, unsigned int);
2637 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644);
2638 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644);
2640 static int param_set_slot_table_size(const char *val, struct kernel_param *kp)
2642 return param_set_uint_minmax(val, kp,
2643 RPC_MIN_SLOT_TABLE,
2644 RPC_MAX_SLOT_TABLE);
2647 static int param_get_slot_table_size(char *buffer, struct kernel_param *kp)
2649 return param_get_uint(buffer, kp);
2651 #define param_check_slot_table_size(name, p) \
2652 __param_check(name, p, unsigned int);
2654 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries,
2655 slot_table_size, 0644);
2656 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries,
2657 slot_table_size, 0644);