1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * linux/net/sunrpc/xprtsock.c 4 * 5 * Client-side transport implementation for sockets. 6 * 7 * TCP callback races fixes (C) 1998 Red Hat 8 * TCP send fixes (C) 1998 Red Hat 9 * TCP NFS related read + write fixes 10 * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie> 11 * 12 * Rewrite of larges part of the code in order to stabilize TCP stuff. 13 * Fix behaviour when socket buffer is full. 14 * (C) 1999 Trond Myklebust <trond.myklebust@fys.uio.no> 15 * 16 * IP socket transport implementation, (C) 2005 Chuck Lever <cel@netapp.com> 17 * 18 * IPv6 support contributed by Gilles Quillard, Bull Open Source, 2005. 19 * <gilles.quillard@bull.net> 20 */ 21 22 #include <linux/types.h> 23 #include <linux/string.h> 24 #include <linux/slab.h> 25 #include <linux/module.h> 26 #include <linux/capability.h> 27 #include <linux/pagemap.h> 28 #include <linux/errno.h> 29 #include <linux/socket.h> 30 #include <linux/in.h> 31 #include <linux/net.h> 32 #include <linux/mm.h> 33 #include <linux/un.h> 34 #include <linux/udp.h> 35 #include <linux/tcp.h> 36 #include <linux/sunrpc/clnt.h> 37 #include <linux/sunrpc/addr.h> 38 #include <linux/sunrpc/sched.h> 39 #include <linux/sunrpc/svcsock.h> 40 #include <linux/sunrpc/xprtsock.h> 41 #include <linux/file.h> 42 #ifdef CONFIG_SUNRPC_BACKCHANNEL 43 #include <linux/sunrpc/bc_xprt.h> 44 #endif 45 46 #include <net/sock.h> 47 #include <net/checksum.h> 48 #include <net/udp.h> 49 #include <net/tcp.h> 50 #include <linux/bvec.h> 51 #include <linux/uio.h> 52 53 #include <trace/events/sunrpc.h> 54 55 #include "sunrpc.h" 56 57 static void xs_close(struct rpc_xprt *xprt); 58 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt, 59 struct socket *sock); 60 61 /* 62 * xprtsock tunables 63 */ 64 static unsigned int xprt_udp_slot_table_entries = RPC_DEF_SLOT_TABLE; 65 static unsigned int xprt_tcp_slot_table_entries = RPC_MIN_SLOT_TABLE; 66 static unsigned int xprt_max_tcp_slot_table_entries = RPC_MAX_SLOT_TABLE; 67 68 static unsigned int xprt_min_resvport = RPC_DEF_MIN_RESVPORT; 69 static unsigned int xprt_max_resvport = RPC_DEF_MAX_RESVPORT; 70 71 #define XS_TCP_LINGER_TO (15U * HZ) 72 static unsigned int xs_tcp_fin_timeout __read_mostly = XS_TCP_LINGER_TO; 73 74 /* 75 * We can register our own files under /proc/sys/sunrpc by 76 * calling register_sysctl_table() again. The files in that 77 * directory become the union of all files registered there. 78 * 79 * We simply need to make sure that we don't collide with 80 * someone else's file names! 81 */ 82 83 static unsigned int min_slot_table_size = RPC_MIN_SLOT_TABLE; 84 static unsigned int max_slot_table_size = RPC_MAX_SLOT_TABLE; 85 static unsigned int max_tcp_slot_table_limit = RPC_MAX_SLOT_TABLE_LIMIT; 86 static unsigned int xprt_min_resvport_limit = RPC_MIN_RESVPORT; 87 static unsigned int xprt_max_resvport_limit = RPC_MAX_RESVPORT; 88 89 static struct ctl_table_header *sunrpc_table_header; 90 91 /* 92 * FIXME: changing the UDP slot table size should also resize the UDP 93 * socket buffers for existing UDP transports 94 */ 95 static struct ctl_table xs_tunables_table[] = { 96 { 97 .procname = "udp_slot_table_entries", 98 .data = &xprt_udp_slot_table_entries, 99 .maxlen = sizeof(unsigned int), 100 .mode = 0644, 101 .proc_handler = proc_dointvec_minmax, 102 .extra1 = &min_slot_table_size, 103 .extra2 = &max_slot_table_size 104 }, 105 { 106 .procname = "tcp_slot_table_entries", 107 .data = &xprt_tcp_slot_table_entries, 108 .maxlen = sizeof(unsigned int), 109 .mode = 0644, 110 .proc_handler = proc_dointvec_minmax, 111 .extra1 = &min_slot_table_size, 112 .extra2 = &max_slot_table_size 113 }, 114 { 115 .procname = "tcp_max_slot_table_entries", 116 .data = &xprt_max_tcp_slot_table_entries, 117 .maxlen = sizeof(unsigned int), 118 .mode = 0644, 119 .proc_handler = proc_dointvec_minmax, 120 .extra1 = &min_slot_table_size, 121 .extra2 = &max_tcp_slot_table_limit 122 }, 123 { 124 .procname = "min_resvport", 125 .data = &xprt_min_resvport, 126 .maxlen = sizeof(unsigned int), 127 .mode = 0644, 128 .proc_handler = proc_dointvec_minmax, 129 .extra1 = &xprt_min_resvport_limit, 130 .extra2 = &xprt_max_resvport_limit 131 }, 132 { 133 .procname = "max_resvport", 134 .data = &xprt_max_resvport, 135 .maxlen = sizeof(unsigned int), 136 .mode = 0644, 137 .proc_handler = proc_dointvec_minmax, 138 .extra1 = &xprt_min_resvport_limit, 139 .extra2 = &xprt_max_resvport_limit 140 }, 141 { 142 .procname = "tcp_fin_timeout", 143 .data = &xs_tcp_fin_timeout, 144 .maxlen = sizeof(xs_tcp_fin_timeout), 145 .mode = 0644, 146 .proc_handler = proc_dointvec_jiffies, 147 }, 148 { }, 149 }; 150 151 static struct ctl_table sunrpc_table[] = { 152 { 153 .procname = "sunrpc", 154 .mode = 0555, 155 .child = xs_tunables_table 156 }, 157 { }, 158 }; 159 160 /* 161 * Wait duration for a reply from the RPC portmapper. 162 */ 163 #define XS_BIND_TO (60U * HZ) 164 165 /* 166 * Delay if a UDP socket connect error occurs. This is most likely some 167 * kind of resource problem on the local host. 168 */ 169 #define XS_UDP_REEST_TO (2U * HZ) 170 171 /* 172 * The reestablish timeout allows clients to delay for a bit before attempting 173 * to reconnect to a server that just dropped our connection. 174 * 175 * We implement an exponential backoff when trying to reestablish a TCP 176 * transport connection with the server. Some servers like to drop a TCP 177 * connection when they are overworked, so we start with a short timeout and 178 * increase over time if the server is down or not responding. 179 */ 180 #define XS_TCP_INIT_REEST_TO (3U * HZ) 181 182 /* 183 * TCP idle timeout; client drops the transport socket if it is idle 184 * for this long. Note that we also timeout UDP sockets to prevent 185 * holding port numbers when there is no RPC traffic. 186 */ 187 #define XS_IDLE_DISC_TO (5U * 60 * HZ) 188 189 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) 190 # undef RPC_DEBUG_DATA 191 # define RPCDBG_FACILITY RPCDBG_TRANS 192 #endif 193 194 #ifdef RPC_DEBUG_DATA 195 static void xs_pktdump(char *msg, u32 *packet, unsigned int count) 196 { 197 u8 *buf = (u8 *) packet; 198 int j; 199 200 dprintk("RPC: %s\n", msg); 201 for (j = 0; j < count && j < 128; j += 4) { 202 if (!(j & 31)) { 203 if (j) 204 dprintk("\n"); 205 dprintk("0x%04x ", j); 206 } 207 dprintk("%02x%02x%02x%02x ", 208 buf[j], buf[j+1], buf[j+2], buf[j+3]); 209 } 210 dprintk("\n"); 211 } 212 #else 213 static inline void xs_pktdump(char *msg, u32 *packet, unsigned int count) 214 { 215 /* NOP */ 216 } 217 #endif 218 219 static inline struct rpc_xprt *xprt_from_sock(struct sock *sk) 220 { 221 return (struct rpc_xprt *) sk->sk_user_data; 222 } 223 224 static inline struct sockaddr *xs_addr(struct rpc_xprt *xprt) 225 { 226 return (struct sockaddr *) &xprt->addr; 227 } 228 229 static inline struct sockaddr_un *xs_addr_un(struct rpc_xprt *xprt) 230 { 231 return (struct sockaddr_un *) &xprt->addr; 232 } 233 234 static inline struct sockaddr_in *xs_addr_in(struct rpc_xprt *xprt) 235 { 236 return (struct sockaddr_in *) &xprt->addr; 237 } 238 239 static inline struct sockaddr_in6 *xs_addr_in6(struct rpc_xprt *xprt) 240 { 241 return (struct sockaddr_in6 *) &xprt->addr; 242 } 243 244 static void xs_format_common_peer_addresses(struct rpc_xprt *xprt) 245 { 246 struct sockaddr *sap = xs_addr(xprt); 247 struct sockaddr_in6 *sin6; 248 struct sockaddr_in *sin; 249 struct sockaddr_un *sun; 250 char buf[128]; 251 252 switch (sap->sa_family) { 253 case AF_LOCAL: 254 sun = xs_addr_un(xprt); 255 strlcpy(buf, sun->sun_path, sizeof(buf)); 256 xprt->address_strings[RPC_DISPLAY_ADDR] = 257 kstrdup(buf, GFP_KERNEL); 258 break; 259 case AF_INET: 260 (void)rpc_ntop(sap, buf, sizeof(buf)); 261 xprt->address_strings[RPC_DISPLAY_ADDR] = 262 kstrdup(buf, GFP_KERNEL); 263 sin = xs_addr_in(xprt); 264 snprintf(buf, sizeof(buf), "%08x", ntohl(sin->sin_addr.s_addr)); 265 break; 266 case AF_INET6: 267 (void)rpc_ntop(sap, buf, sizeof(buf)); 268 xprt->address_strings[RPC_DISPLAY_ADDR] = 269 kstrdup(buf, GFP_KERNEL); 270 sin6 = xs_addr_in6(xprt); 271 snprintf(buf, sizeof(buf), "%pi6", &sin6->sin6_addr); 272 break; 273 default: 274 BUG(); 275 } 276 277 xprt->address_strings[RPC_DISPLAY_HEX_ADDR] = kstrdup(buf, GFP_KERNEL); 278 } 279 280 static void xs_format_common_peer_ports(struct rpc_xprt *xprt) 281 { 282 struct sockaddr *sap = xs_addr(xprt); 283 char buf[128]; 284 285 snprintf(buf, sizeof(buf), "%u", rpc_get_port(sap)); 286 xprt->address_strings[RPC_DISPLAY_PORT] = kstrdup(buf, GFP_KERNEL); 287 288 snprintf(buf, sizeof(buf), "%4hx", rpc_get_port(sap)); 289 xprt->address_strings[RPC_DISPLAY_HEX_PORT] = kstrdup(buf, GFP_KERNEL); 290 } 291 292 static void xs_format_peer_addresses(struct rpc_xprt *xprt, 293 const char *protocol, 294 const char *netid) 295 { 296 xprt->address_strings[RPC_DISPLAY_PROTO] = protocol; 297 xprt->address_strings[RPC_DISPLAY_NETID] = netid; 298 xs_format_common_peer_addresses(xprt); 299 xs_format_common_peer_ports(xprt); 300 } 301 302 static void xs_update_peer_port(struct rpc_xprt *xprt) 303 { 304 kfree(xprt->address_strings[RPC_DISPLAY_HEX_PORT]); 305 kfree(xprt->address_strings[RPC_DISPLAY_PORT]); 306 307 xs_format_common_peer_ports(xprt); 308 } 309 310 static void xs_free_peer_addresses(struct rpc_xprt *xprt) 311 { 312 unsigned int i; 313 314 for (i = 0; i < RPC_DISPLAY_MAX; i++) 315 switch (i) { 316 case RPC_DISPLAY_PROTO: 317 case RPC_DISPLAY_NETID: 318 continue; 319 default: 320 kfree(xprt->address_strings[i]); 321 } 322 } 323 324 static size_t 325 xs_alloc_sparse_pages(struct xdr_buf *buf, size_t want, gfp_t gfp) 326 { 327 size_t i,n; 328 329 if (!want || !(buf->flags & XDRBUF_SPARSE_PAGES)) 330 return want; 331 n = (buf->page_base + want + PAGE_SIZE - 1) >> PAGE_SHIFT; 332 for (i = 0; i < n; i++) { 333 if (buf->pages[i]) 334 continue; 335 buf->bvec[i].bv_page = buf->pages[i] = alloc_page(gfp); 336 if (!buf->pages[i]) { 337 i *= PAGE_SIZE; 338 return i > buf->page_base ? i - buf->page_base : 0; 339 } 340 } 341 return want; 342 } 343 344 static ssize_t 345 xs_sock_recvmsg(struct socket *sock, struct msghdr *msg, int flags, size_t seek) 346 { 347 ssize_t ret; 348 if (seek != 0) 349 iov_iter_advance(&msg->msg_iter, seek); 350 ret = sock_recvmsg(sock, msg, flags); 351 return ret > 0 ? ret + seek : ret; 352 } 353 354 static ssize_t 355 xs_read_kvec(struct socket *sock, struct msghdr *msg, int flags, 356 struct kvec *kvec, size_t count, size_t seek) 357 { 358 iov_iter_kvec(&msg->msg_iter, READ, kvec, 1, count); 359 return xs_sock_recvmsg(sock, msg, flags, seek); 360 } 361 362 static ssize_t 363 xs_read_bvec(struct socket *sock, struct msghdr *msg, int flags, 364 struct bio_vec *bvec, unsigned long nr, size_t count, 365 size_t seek) 366 { 367 iov_iter_bvec(&msg->msg_iter, READ, bvec, nr, count); 368 return xs_sock_recvmsg(sock, msg, flags, seek); 369 } 370 371 static ssize_t 372 xs_read_discard(struct socket *sock, struct msghdr *msg, int flags, 373 size_t count) 374 { 375 iov_iter_discard(&msg->msg_iter, READ, count); 376 return sock_recvmsg(sock, msg, flags); 377 } 378 379 static ssize_t 380 xs_read_xdr_buf(struct socket *sock, struct msghdr *msg, int flags, 381 struct xdr_buf *buf, size_t count, size_t seek, size_t *read) 382 { 383 size_t want, seek_init = seek, offset = 0; 384 ssize_t ret; 385 386 if (seek < buf->head[0].iov_len) { 387 want = min_t(size_t, count, buf->head[0].iov_len); 388 ret = xs_read_kvec(sock, msg, flags, &buf->head[0], want, seek); 389 if (ret <= 0) 390 goto sock_err; 391 offset += ret; 392 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC)) 393 goto out; 394 if (ret != want) 395 goto out; 396 seek = 0; 397 } else { 398 seek -= buf->head[0].iov_len; 399 offset += buf->head[0].iov_len; 400 } 401 402 want = xs_alloc_sparse_pages(buf, 403 min_t(size_t, count - offset, buf->page_len), 404 GFP_NOWAIT); 405 if (seek < want) { 406 ret = xs_read_bvec(sock, msg, flags, buf->bvec, 407 xdr_buf_pagecount(buf), 408 want + buf->page_base, 409 seek + buf->page_base); 410 if (ret <= 0) 411 goto sock_err; 412 offset += ret - buf->page_base; 413 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC)) 414 goto out; 415 if (ret != want) 416 goto out; 417 seek = 0; 418 } else { 419 seek -= want; 420 offset += want; 421 } 422 423 if (seek < buf->tail[0].iov_len) { 424 want = min_t(size_t, count - offset, buf->tail[0].iov_len); 425 ret = xs_read_kvec(sock, msg, flags, &buf->tail[0], want, seek); 426 if (ret <= 0) 427 goto sock_err; 428 offset += ret; 429 if (offset == count || msg->msg_flags & (MSG_EOR|MSG_TRUNC)) 430 goto out; 431 if (ret != want) 432 goto out; 433 } else 434 offset += buf->tail[0].iov_len; 435 ret = -EMSGSIZE; 436 out: 437 *read = offset - seek_init; 438 return ret; 439 sock_err: 440 offset += seek; 441 goto out; 442 } 443 444 static void 445 xs_read_header(struct sock_xprt *transport, struct xdr_buf *buf) 446 { 447 if (!transport->recv.copied) { 448 if (buf->head[0].iov_len >= transport->recv.offset) 449 memcpy(buf->head[0].iov_base, 450 &transport->recv.xid, 451 transport->recv.offset); 452 transport->recv.copied = transport->recv.offset; 453 } 454 } 455 456 static bool 457 xs_read_stream_request_done(struct sock_xprt *transport) 458 { 459 return transport->recv.fraghdr & cpu_to_be32(RPC_LAST_STREAM_FRAGMENT); 460 } 461 462 static ssize_t 463 xs_read_stream_request(struct sock_xprt *transport, struct msghdr *msg, 464 int flags, struct rpc_rqst *req) 465 { 466 struct xdr_buf *buf = &req->rq_private_buf; 467 size_t want, read; 468 ssize_t ret; 469 470 xs_read_header(transport, buf); 471 472 want = transport->recv.len - transport->recv.offset; 473 ret = xs_read_xdr_buf(transport->sock, msg, flags, buf, 474 transport->recv.copied + want, transport->recv.copied, 475 &read); 476 transport->recv.offset += read; 477 transport->recv.copied += read; 478 if (transport->recv.offset == transport->recv.len) { 479 if (xs_read_stream_request_done(transport)) 480 msg->msg_flags |= MSG_EOR; 481 return read; 482 } 483 484 switch (ret) { 485 default: 486 break; 487 case -EFAULT: 488 case -EMSGSIZE: 489 msg->msg_flags |= MSG_TRUNC; 490 return read; 491 case 0: 492 return -ESHUTDOWN; 493 } 494 return ret < 0 ? ret : read; 495 } 496 497 static size_t 498 xs_read_stream_headersize(bool isfrag) 499 { 500 if (isfrag) 501 return sizeof(__be32); 502 return 3 * sizeof(__be32); 503 } 504 505 static ssize_t 506 xs_read_stream_header(struct sock_xprt *transport, struct msghdr *msg, 507 int flags, size_t want, size_t seek) 508 { 509 struct kvec kvec = { 510 .iov_base = &transport->recv.fraghdr, 511 .iov_len = want, 512 }; 513 return xs_read_kvec(transport->sock, msg, flags, &kvec, want, seek); 514 } 515 516 #if defined(CONFIG_SUNRPC_BACKCHANNEL) 517 static ssize_t 518 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags) 519 { 520 struct rpc_xprt *xprt = &transport->xprt; 521 struct rpc_rqst *req; 522 ssize_t ret; 523 524 /* Look up and lock the request corresponding to the given XID */ 525 req = xprt_lookup_bc_request(xprt, transport->recv.xid); 526 if (!req) { 527 printk(KERN_WARNING "Callback slot table overflowed\n"); 528 return -ESHUTDOWN; 529 } 530 531 ret = xs_read_stream_request(transport, msg, flags, req); 532 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC)) 533 xprt_complete_bc_request(req, transport->recv.copied); 534 535 return ret; 536 } 537 #else /* CONFIG_SUNRPC_BACKCHANNEL */ 538 static ssize_t 539 xs_read_stream_call(struct sock_xprt *transport, struct msghdr *msg, int flags) 540 { 541 return -ESHUTDOWN; 542 } 543 #endif /* CONFIG_SUNRPC_BACKCHANNEL */ 544 545 static ssize_t 546 xs_read_stream_reply(struct sock_xprt *transport, struct msghdr *msg, int flags) 547 { 548 struct rpc_xprt *xprt = &transport->xprt; 549 struct rpc_rqst *req; 550 ssize_t ret = 0; 551 552 /* Look up and lock the request corresponding to the given XID */ 553 spin_lock(&xprt->queue_lock); 554 req = xprt_lookup_rqst(xprt, transport->recv.xid); 555 if (!req) { 556 msg->msg_flags |= MSG_TRUNC; 557 goto out; 558 } 559 xprt_pin_rqst(req); 560 spin_unlock(&xprt->queue_lock); 561 562 ret = xs_read_stream_request(transport, msg, flags, req); 563 564 spin_lock(&xprt->queue_lock); 565 if (msg->msg_flags & (MSG_EOR|MSG_TRUNC)) 566 xprt_complete_rqst(req->rq_task, transport->recv.copied); 567 xprt_unpin_rqst(req); 568 out: 569 spin_unlock(&xprt->queue_lock); 570 return ret; 571 } 572 573 static ssize_t 574 xs_read_stream(struct sock_xprt *transport, int flags) 575 { 576 struct msghdr msg = { 0 }; 577 size_t want, read = 0; 578 ssize_t ret = 0; 579 580 if (transport->recv.len == 0) { 581 want = xs_read_stream_headersize(transport->recv.copied != 0); 582 ret = xs_read_stream_header(transport, &msg, flags, want, 583 transport->recv.offset); 584 if (ret <= 0) 585 goto out_err; 586 transport->recv.offset = ret; 587 if (transport->recv.offset != want) 588 return transport->recv.offset; 589 transport->recv.len = be32_to_cpu(transport->recv.fraghdr) & 590 RPC_FRAGMENT_SIZE_MASK; 591 transport->recv.offset -= sizeof(transport->recv.fraghdr); 592 read = ret; 593 } 594 595 switch (be32_to_cpu(transport->recv.calldir)) { 596 default: 597 msg.msg_flags |= MSG_TRUNC; 598 break; 599 case RPC_CALL: 600 ret = xs_read_stream_call(transport, &msg, flags); 601 break; 602 case RPC_REPLY: 603 ret = xs_read_stream_reply(transport, &msg, flags); 604 } 605 if (msg.msg_flags & MSG_TRUNC) { 606 transport->recv.calldir = cpu_to_be32(-1); 607 transport->recv.copied = -1; 608 } 609 if (ret < 0) 610 goto out_err; 611 read += ret; 612 if (transport->recv.offset < transport->recv.len) { 613 if (!(msg.msg_flags & MSG_TRUNC)) 614 return read; 615 msg.msg_flags = 0; 616 ret = xs_read_discard(transport->sock, &msg, flags, 617 transport->recv.len - transport->recv.offset); 618 if (ret <= 0) 619 goto out_err; 620 transport->recv.offset += ret; 621 read += ret; 622 if (transport->recv.offset != transport->recv.len) 623 return read; 624 } 625 if (xs_read_stream_request_done(transport)) { 626 trace_xs_stream_read_request(transport); 627 transport->recv.copied = 0; 628 } 629 transport->recv.offset = 0; 630 transport->recv.len = 0; 631 return read; 632 out_err: 633 return ret != 0 ? ret : -ESHUTDOWN; 634 } 635 636 static void xs_stream_data_receive(struct sock_xprt *transport) 637 { 638 size_t read = 0; 639 ssize_t ret = 0; 640 641 mutex_lock(&transport->recv_mutex); 642 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state); 643 if (transport->sock == NULL) 644 goto out; 645 for (;;) { 646 ret = xs_read_stream(transport, MSG_DONTWAIT); 647 if (ret < 0) 648 break; 649 read += ret; 650 cond_resched(); 651 } 652 out: 653 mutex_unlock(&transport->recv_mutex); 654 trace_xs_stream_read_data(&transport->xprt, ret, read); 655 } 656 657 static void xs_stream_data_receive_workfn(struct work_struct *work) 658 { 659 struct sock_xprt *transport = 660 container_of(work, struct sock_xprt, recv_worker); 661 xs_stream_data_receive(transport); 662 } 663 664 static void 665 xs_stream_reset_connect(struct sock_xprt *transport) 666 { 667 transport->recv.offset = 0; 668 transport->recv.len = 0; 669 transport->recv.copied = 0; 670 transport->xmit.offset = 0; 671 transport->xprt.stat.connect_count++; 672 transport->xprt.stat.connect_start = jiffies; 673 } 674 675 #define XS_SENDMSG_FLAGS (MSG_DONTWAIT | MSG_NOSIGNAL) 676 677 static int xs_send_kvec(struct socket *sock, struct sockaddr *addr, int addrlen, struct kvec *vec, unsigned int base, int more) 678 { 679 struct msghdr msg = { 680 .msg_name = addr, 681 .msg_namelen = addrlen, 682 .msg_flags = XS_SENDMSG_FLAGS | (more ? MSG_MORE : 0), 683 }; 684 struct kvec iov = { 685 .iov_base = vec->iov_base + base, 686 .iov_len = vec->iov_len - base, 687 }; 688 689 if (iov.iov_len != 0) 690 return kernel_sendmsg(sock, &msg, &iov, 1, iov.iov_len); 691 return kernel_sendmsg(sock, &msg, NULL, 0, 0); 692 } 693 694 static int xs_send_pagedata(struct socket *sock, struct xdr_buf *xdr, unsigned int base, int more, bool zerocopy, int *sent_p) 695 { 696 ssize_t (*do_sendpage)(struct socket *sock, struct page *page, 697 int offset, size_t size, int flags); 698 struct page **ppage; 699 unsigned int remainder; 700 int err; 701 702 remainder = xdr->page_len - base; 703 base += xdr->page_base; 704 ppage = xdr->pages + (base >> PAGE_SHIFT); 705 base &= ~PAGE_MASK; 706 do_sendpage = sock->ops->sendpage; 707 if (!zerocopy) 708 do_sendpage = sock_no_sendpage; 709 for(;;) { 710 unsigned int len = min_t(unsigned int, PAGE_SIZE - base, remainder); 711 int flags = XS_SENDMSG_FLAGS; 712 713 remainder -= len; 714 if (more) 715 flags |= MSG_MORE; 716 if (remainder != 0) 717 flags |= MSG_SENDPAGE_NOTLAST | MSG_MORE; 718 err = do_sendpage(sock, *ppage, base, len, flags); 719 if (remainder == 0 || err != len) 720 break; 721 *sent_p += err; 722 ppage++; 723 base = 0; 724 } 725 if (err > 0) { 726 *sent_p += err; 727 err = 0; 728 } 729 return err; 730 } 731 732 /** 733 * xs_sendpages - write pages directly to a socket 734 * @sock: socket to send on 735 * @addr: UDP only -- address of destination 736 * @addrlen: UDP only -- length of destination address 737 * @xdr: buffer containing this request 738 * @base: starting position in the buffer 739 * @zerocopy: true if it is safe to use sendpage() 740 * @sent_p: return the total number of bytes successfully queued for sending 741 * 742 */ 743 static int xs_sendpages(struct socket *sock, struct sockaddr *addr, int addrlen, struct xdr_buf *xdr, unsigned int base, bool zerocopy, int *sent_p) 744 { 745 unsigned int remainder = xdr->len - base; 746 int err = 0; 747 int sent = 0; 748 749 if (unlikely(!sock)) 750 return -ENOTSOCK; 751 752 if (base != 0) { 753 addr = NULL; 754 addrlen = 0; 755 } 756 757 if (base < xdr->head[0].iov_len || addr != NULL) { 758 unsigned int len = xdr->head[0].iov_len - base; 759 remainder -= len; 760 err = xs_send_kvec(sock, addr, addrlen, &xdr->head[0], base, remainder != 0); 761 if (remainder == 0 || err != len) 762 goto out; 763 *sent_p += err; 764 base = 0; 765 } else 766 base -= xdr->head[0].iov_len; 767 768 if (base < xdr->page_len) { 769 unsigned int len = xdr->page_len - base; 770 remainder -= len; 771 err = xs_send_pagedata(sock, xdr, base, remainder != 0, zerocopy, &sent); 772 *sent_p += sent; 773 if (remainder == 0 || sent != len) 774 goto out; 775 base = 0; 776 } else 777 base -= xdr->page_len; 778 779 if (base >= xdr->tail[0].iov_len) 780 return 0; 781 err = xs_send_kvec(sock, NULL, 0, &xdr->tail[0], base, 0); 782 out: 783 if (err > 0) { 784 *sent_p += err; 785 err = 0; 786 } 787 return err; 788 } 789 790 /** 791 * xs_nospace - handle transmit was incomplete 792 * @req: pointer to RPC request 793 * 794 */ 795 static int xs_nospace(struct rpc_rqst *req) 796 { 797 struct rpc_xprt *xprt = req->rq_xprt; 798 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 799 struct sock *sk = transport->inet; 800 int ret = -EAGAIN; 801 802 dprintk("RPC: %5u xmit incomplete (%u left of %u)\n", 803 req->rq_task->tk_pid, 804 req->rq_slen - transport->xmit.offset, 805 req->rq_slen); 806 807 /* Protect against races with write_space */ 808 spin_lock_bh(&xprt->transport_lock); 809 810 /* Don't race with disconnect */ 811 if (xprt_connected(xprt)) { 812 /* wait for more buffer space */ 813 sk->sk_write_pending++; 814 xprt_wait_for_buffer_space(xprt); 815 } else 816 ret = -ENOTCONN; 817 818 spin_unlock_bh(&xprt->transport_lock); 819 820 /* Race breaker in case memory is freed before above code is called */ 821 if (ret == -EAGAIN) { 822 struct socket_wq *wq; 823 824 rcu_read_lock(); 825 wq = rcu_dereference(sk->sk_wq); 826 set_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags); 827 rcu_read_unlock(); 828 829 sk->sk_write_space(sk); 830 } 831 return ret; 832 } 833 834 static void 835 xs_stream_prepare_request(struct rpc_rqst *req) 836 { 837 req->rq_task->tk_status = xdr_alloc_bvec(&req->rq_rcv_buf, GFP_NOIO); 838 } 839 840 /* 841 * Determine if the previous message in the stream was aborted before it 842 * could complete transmission. 843 */ 844 static bool 845 xs_send_request_was_aborted(struct sock_xprt *transport, struct rpc_rqst *req) 846 { 847 return transport->xmit.offset != 0 && req->rq_bytes_sent == 0; 848 } 849 850 /* 851 * Construct a stream transport record marker in @buf. 852 */ 853 static inline void xs_encode_stream_record_marker(struct xdr_buf *buf) 854 { 855 u32 reclen = buf->len - sizeof(rpc_fraghdr); 856 rpc_fraghdr *base = buf->head[0].iov_base; 857 *base = cpu_to_be32(RPC_LAST_STREAM_FRAGMENT | reclen); 858 } 859 860 /** 861 * xs_local_send_request - write an RPC request to an AF_LOCAL socket 862 * @req: pointer to RPC request 863 * 864 * Return values: 865 * 0: The request has been sent 866 * EAGAIN: The socket was blocked, please call again later to 867 * complete the request 868 * ENOTCONN: Caller needs to invoke connect logic then call again 869 * other: Some other error occured, the request was not sent 870 */ 871 static int xs_local_send_request(struct rpc_rqst *req) 872 { 873 struct rpc_xprt *xprt = req->rq_xprt; 874 struct sock_xprt *transport = 875 container_of(xprt, struct sock_xprt, xprt); 876 struct xdr_buf *xdr = &req->rq_snd_buf; 877 int status; 878 int sent = 0; 879 880 /* Close the stream if the previous transmission was incomplete */ 881 if (xs_send_request_was_aborted(transport, req)) { 882 xs_close(xprt); 883 return -ENOTCONN; 884 } 885 886 xs_encode_stream_record_marker(&req->rq_snd_buf); 887 888 xs_pktdump("packet data:", 889 req->rq_svec->iov_base, req->rq_svec->iov_len); 890 891 req->rq_xtime = ktime_get(); 892 status = xs_sendpages(transport->sock, NULL, 0, xdr, 893 transport->xmit.offset, 894 true, &sent); 895 dprintk("RPC: %s(%u) = %d\n", 896 __func__, xdr->len - transport->xmit.offset, status); 897 898 if (status == -EAGAIN && sock_writeable(transport->inet)) 899 status = -ENOBUFS; 900 901 if (likely(sent > 0) || status == 0) { 902 transport->xmit.offset += sent; 903 req->rq_bytes_sent = transport->xmit.offset; 904 if (likely(req->rq_bytes_sent >= req->rq_slen)) { 905 req->rq_xmit_bytes_sent += transport->xmit.offset; 906 req->rq_bytes_sent = 0; 907 transport->xmit.offset = 0; 908 return 0; 909 } 910 status = -EAGAIN; 911 } 912 913 switch (status) { 914 case -ENOBUFS: 915 break; 916 case -EAGAIN: 917 status = xs_nospace(req); 918 break; 919 default: 920 dprintk("RPC: sendmsg returned unrecognized error %d\n", 921 -status); 922 /* fall through */ 923 case -EPIPE: 924 xs_close(xprt); 925 status = -ENOTCONN; 926 } 927 928 return status; 929 } 930 931 /** 932 * xs_udp_send_request - write an RPC request to a UDP socket 933 * @req: pointer to RPC request 934 * 935 * Return values: 936 * 0: The request has been sent 937 * EAGAIN: The socket was blocked, please call again later to 938 * complete the request 939 * ENOTCONN: Caller needs to invoke connect logic then call again 940 * other: Some other error occurred, the request was not sent 941 */ 942 static int xs_udp_send_request(struct rpc_rqst *req) 943 { 944 struct rpc_xprt *xprt = req->rq_xprt; 945 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 946 struct xdr_buf *xdr = &req->rq_snd_buf; 947 int sent = 0; 948 int status; 949 950 xs_pktdump("packet data:", 951 req->rq_svec->iov_base, 952 req->rq_svec->iov_len); 953 954 if (!xprt_bound(xprt)) 955 return -ENOTCONN; 956 957 if (!xprt_request_get_cong(xprt, req)) 958 return -EBADSLT; 959 960 req->rq_xtime = ktime_get(); 961 status = xs_sendpages(transport->sock, xs_addr(xprt), xprt->addrlen, 962 xdr, 0, true, &sent); 963 964 dprintk("RPC: xs_udp_send_request(%u) = %d\n", 965 xdr->len, status); 966 967 /* firewall is blocking us, don't return -EAGAIN or we end up looping */ 968 if (status == -EPERM) 969 goto process_status; 970 971 if (status == -EAGAIN && sock_writeable(transport->inet)) 972 status = -ENOBUFS; 973 974 if (sent > 0 || status == 0) { 975 req->rq_xmit_bytes_sent += sent; 976 if (sent >= req->rq_slen) 977 return 0; 978 /* Still some bytes left; set up for a retry later. */ 979 status = -EAGAIN; 980 } 981 982 process_status: 983 switch (status) { 984 case -ENOTSOCK: 985 status = -ENOTCONN; 986 /* Should we call xs_close() here? */ 987 break; 988 case -EAGAIN: 989 status = xs_nospace(req); 990 break; 991 case -ENETUNREACH: 992 case -ENOBUFS: 993 case -EPIPE: 994 case -ECONNREFUSED: 995 case -EPERM: 996 /* When the server has died, an ICMP port unreachable message 997 * prompts ECONNREFUSED. */ 998 break; 999 default: 1000 dprintk("RPC: sendmsg returned unrecognized error %d\n", 1001 -status); 1002 } 1003 1004 return status; 1005 } 1006 1007 /** 1008 * xs_tcp_send_request - write an RPC request to a TCP socket 1009 * @req: pointer to RPC request 1010 * 1011 * Return values: 1012 * 0: The request has been sent 1013 * EAGAIN: The socket was blocked, please call again later to 1014 * complete the request 1015 * ENOTCONN: Caller needs to invoke connect logic then call again 1016 * other: Some other error occurred, the request was not sent 1017 * 1018 * XXX: In the case of soft timeouts, should we eventually give up 1019 * if sendmsg is not able to make progress? 1020 */ 1021 static int xs_tcp_send_request(struct rpc_rqst *req) 1022 { 1023 struct rpc_xprt *xprt = req->rq_xprt; 1024 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 1025 struct xdr_buf *xdr = &req->rq_snd_buf; 1026 bool zerocopy = true; 1027 bool vm_wait = false; 1028 int status; 1029 int sent; 1030 1031 /* Close the stream if the previous transmission was incomplete */ 1032 if (xs_send_request_was_aborted(transport, req)) { 1033 if (transport->sock != NULL) 1034 kernel_sock_shutdown(transport->sock, SHUT_RDWR); 1035 return -ENOTCONN; 1036 } 1037 1038 xs_encode_stream_record_marker(&req->rq_snd_buf); 1039 1040 xs_pktdump("packet data:", 1041 req->rq_svec->iov_base, 1042 req->rq_svec->iov_len); 1043 /* Don't use zero copy if this is a resend. If the RPC call 1044 * completes while the socket holds a reference to the pages, 1045 * then we may end up resending corrupted data. 1046 */ 1047 if (req->rq_task->tk_flags & RPC_TASK_SENT) 1048 zerocopy = false; 1049 1050 if (test_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state)) 1051 xs_tcp_set_socket_timeouts(xprt, transport->sock); 1052 1053 /* Continue transmitting the packet/record. We must be careful 1054 * to cope with writespace callbacks arriving _after_ we have 1055 * called sendmsg(). */ 1056 req->rq_xtime = ktime_get(); 1057 while (1) { 1058 sent = 0; 1059 status = xs_sendpages(transport->sock, NULL, 0, xdr, 1060 transport->xmit.offset, 1061 zerocopy, &sent); 1062 1063 dprintk("RPC: xs_tcp_send_request(%u) = %d\n", 1064 xdr->len - transport->xmit.offset, status); 1065 1066 /* If we've sent the entire packet, immediately 1067 * reset the count of bytes sent. */ 1068 transport->xmit.offset += sent; 1069 req->rq_bytes_sent = transport->xmit.offset; 1070 if (likely(req->rq_bytes_sent >= req->rq_slen)) { 1071 req->rq_xmit_bytes_sent += transport->xmit.offset; 1072 req->rq_bytes_sent = 0; 1073 transport->xmit.offset = 0; 1074 return 0; 1075 } 1076 1077 WARN_ON_ONCE(sent == 0 && status == 0); 1078 1079 if (status == -EAGAIN ) { 1080 /* 1081 * Return EAGAIN if we're sure we're hitting the 1082 * socket send buffer limits. 1083 */ 1084 if (test_bit(SOCK_NOSPACE, &transport->sock->flags)) 1085 break; 1086 /* 1087 * Did we hit a memory allocation failure? 1088 */ 1089 if (sent == 0) { 1090 status = -ENOBUFS; 1091 if (vm_wait) 1092 break; 1093 /* Retry, knowing now that we're below the 1094 * socket send buffer limit 1095 */ 1096 vm_wait = true; 1097 } 1098 continue; 1099 } 1100 if (status < 0) 1101 break; 1102 vm_wait = false; 1103 } 1104 1105 switch (status) { 1106 case -ENOTSOCK: 1107 status = -ENOTCONN; 1108 /* Should we call xs_close() here? */ 1109 break; 1110 case -EAGAIN: 1111 status = xs_nospace(req); 1112 break; 1113 case -ECONNRESET: 1114 case -ECONNREFUSED: 1115 case -ENOTCONN: 1116 case -EADDRINUSE: 1117 case -ENOBUFS: 1118 case -EPIPE: 1119 break; 1120 default: 1121 dprintk("RPC: sendmsg returned unrecognized error %d\n", 1122 -status); 1123 } 1124 1125 return status; 1126 } 1127 1128 static void xs_save_old_callbacks(struct sock_xprt *transport, struct sock *sk) 1129 { 1130 transport->old_data_ready = sk->sk_data_ready; 1131 transport->old_state_change = sk->sk_state_change; 1132 transport->old_write_space = sk->sk_write_space; 1133 transport->old_error_report = sk->sk_error_report; 1134 } 1135 1136 static void xs_restore_old_callbacks(struct sock_xprt *transport, struct sock *sk) 1137 { 1138 sk->sk_data_ready = transport->old_data_ready; 1139 sk->sk_state_change = transport->old_state_change; 1140 sk->sk_write_space = transport->old_write_space; 1141 sk->sk_error_report = transport->old_error_report; 1142 } 1143 1144 static void xs_sock_reset_state_flags(struct rpc_xprt *xprt) 1145 { 1146 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 1147 1148 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state); 1149 } 1150 1151 static void xs_sock_reset_connection_flags(struct rpc_xprt *xprt) 1152 { 1153 smp_mb__before_atomic(); 1154 clear_bit(XPRT_CLOSE_WAIT, &xprt->state); 1155 clear_bit(XPRT_CLOSING, &xprt->state); 1156 xs_sock_reset_state_flags(xprt); 1157 smp_mb__after_atomic(); 1158 } 1159 1160 /** 1161 * xs_error_report - callback to handle TCP socket state errors 1162 * @sk: socket 1163 * 1164 * Note: we don't call sock_error() since there may be a rpc_task 1165 * using the socket, and so we don't want to clear sk->sk_err. 1166 */ 1167 static void xs_error_report(struct sock *sk) 1168 { 1169 struct rpc_xprt *xprt; 1170 int err; 1171 1172 read_lock_bh(&sk->sk_callback_lock); 1173 if (!(xprt = xprt_from_sock(sk))) 1174 goto out; 1175 1176 err = -sk->sk_err; 1177 if (err == 0) 1178 goto out; 1179 dprintk("RPC: xs_error_report client %p, error=%d...\n", 1180 xprt, -err); 1181 trace_rpc_socket_error(xprt, sk->sk_socket, err); 1182 xprt_wake_pending_tasks(xprt, err); 1183 out: 1184 read_unlock_bh(&sk->sk_callback_lock); 1185 } 1186 1187 static void xs_reset_transport(struct sock_xprt *transport) 1188 { 1189 struct socket *sock = transport->sock; 1190 struct sock *sk = transport->inet; 1191 struct rpc_xprt *xprt = &transport->xprt; 1192 1193 if (sk == NULL) 1194 return; 1195 1196 if (atomic_read(&transport->xprt.swapper)) 1197 sk_clear_memalloc(sk); 1198 1199 kernel_sock_shutdown(sock, SHUT_RDWR); 1200 1201 mutex_lock(&transport->recv_mutex); 1202 write_lock_bh(&sk->sk_callback_lock); 1203 transport->inet = NULL; 1204 transport->sock = NULL; 1205 1206 sk->sk_user_data = NULL; 1207 1208 xs_restore_old_callbacks(transport, sk); 1209 xprt_clear_connected(xprt); 1210 write_unlock_bh(&sk->sk_callback_lock); 1211 xs_sock_reset_connection_flags(xprt); 1212 mutex_unlock(&transport->recv_mutex); 1213 1214 trace_rpc_socket_close(xprt, sock); 1215 sock_release(sock); 1216 1217 xprt_disconnect_done(xprt); 1218 } 1219 1220 /** 1221 * xs_close - close a socket 1222 * @xprt: transport 1223 * 1224 * This is used when all requests are complete; ie, no DRC state remains 1225 * on the server we want to save. 1226 * 1227 * The caller _must_ be holding XPRT_LOCKED in order to avoid issues with 1228 * xs_reset_transport() zeroing the socket from underneath a writer. 1229 */ 1230 static void xs_close(struct rpc_xprt *xprt) 1231 { 1232 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 1233 1234 dprintk("RPC: xs_close xprt %p\n", xprt); 1235 1236 xs_reset_transport(transport); 1237 xprt->reestablish_timeout = 0; 1238 } 1239 1240 static void xs_inject_disconnect(struct rpc_xprt *xprt) 1241 { 1242 dprintk("RPC: injecting transport disconnect on xprt=%p\n", 1243 xprt); 1244 xprt_disconnect_done(xprt); 1245 } 1246 1247 static void xs_xprt_free(struct rpc_xprt *xprt) 1248 { 1249 xs_free_peer_addresses(xprt); 1250 xprt_free(xprt); 1251 } 1252 1253 /** 1254 * xs_destroy - prepare to shutdown a transport 1255 * @xprt: doomed transport 1256 * 1257 */ 1258 static void xs_destroy(struct rpc_xprt *xprt) 1259 { 1260 struct sock_xprt *transport = container_of(xprt, 1261 struct sock_xprt, xprt); 1262 dprintk("RPC: xs_destroy xprt %p\n", xprt); 1263 1264 cancel_delayed_work_sync(&transport->connect_worker); 1265 xs_close(xprt); 1266 cancel_work_sync(&transport->recv_worker); 1267 xs_xprt_free(xprt); 1268 module_put(THIS_MODULE); 1269 } 1270 1271 /** 1272 * xs_udp_data_read_skb - receive callback for UDP sockets 1273 * @xprt: transport 1274 * @sk: socket 1275 * @skb: skbuff 1276 * 1277 */ 1278 static void xs_udp_data_read_skb(struct rpc_xprt *xprt, 1279 struct sock *sk, 1280 struct sk_buff *skb) 1281 { 1282 struct rpc_task *task; 1283 struct rpc_rqst *rovr; 1284 int repsize, copied; 1285 u32 _xid; 1286 __be32 *xp; 1287 1288 repsize = skb->len; 1289 if (repsize < 4) { 1290 dprintk("RPC: impossible RPC reply size %d!\n", repsize); 1291 return; 1292 } 1293 1294 /* Copy the XID from the skb... */ 1295 xp = skb_header_pointer(skb, 0, sizeof(_xid), &_xid); 1296 if (xp == NULL) 1297 return; 1298 1299 /* Look up and lock the request corresponding to the given XID */ 1300 spin_lock(&xprt->queue_lock); 1301 rovr = xprt_lookup_rqst(xprt, *xp); 1302 if (!rovr) 1303 goto out_unlock; 1304 xprt_pin_rqst(rovr); 1305 xprt_update_rtt(rovr->rq_task); 1306 spin_unlock(&xprt->queue_lock); 1307 task = rovr->rq_task; 1308 1309 if ((copied = rovr->rq_private_buf.buflen) > repsize) 1310 copied = repsize; 1311 1312 /* Suck it into the iovec, verify checksum if not done by hw. */ 1313 if (csum_partial_copy_to_xdr(&rovr->rq_private_buf, skb)) { 1314 spin_lock(&xprt->queue_lock); 1315 __UDPX_INC_STATS(sk, UDP_MIB_INERRORS); 1316 goto out_unpin; 1317 } 1318 1319 1320 spin_lock_bh(&xprt->transport_lock); 1321 xprt_adjust_cwnd(xprt, task, copied); 1322 spin_unlock_bh(&xprt->transport_lock); 1323 spin_lock(&xprt->queue_lock); 1324 xprt_complete_rqst(task, copied); 1325 __UDPX_INC_STATS(sk, UDP_MIB_INDATAGRAMS); 1326 out_unpin: 1327 xprt_unpin_rqst(rovr); 1328 out_unlock: 1329 spin_unlock(&xprt->queue_lock); 1330 } 1331 1332 static void xs_udp_data_receive(struct sock_xprt *transport) 1333 { 1334 struct sk_buff *skb; 1335 struct sock *sk; 1336 int err; 1337 1338 mutex_lock(&transport->recv_mutex); 1339 clear_bit(XPRT_SOCK_DATA_READY, &transport->sock_state); 1340 sk = transport->inet; 1341 if (sk == NULL) 1342 goto out; 1343 for (;;) { 1344 skb = skb_recv_udp(sk, 0, 1, &err); 1345 if (skb == NULL) 1346 break; 1347 xs_udp_data_read_skb(&transport->xprt, sk, skb); 1348 consume_skb(skb); 1349 cond_resched(); 1350 } 1351 out: 1352 mutex_unlock(&transport->recv_mutex); 1353 } 1354 1355 static void xs_udp_data_receive_workfn(struct work_struct *work) 1356 { 1357 struct sock_xprt *transport = 1358 container_of(work, struct sock_xprt, recv_worker); 1359 xs_udp_data_receive(transport); 1360 } 1361 1362 /** 1363 * xs_data_ready - "data ready" callback for UDP sockets 1364 * @sk: socket with data to read 1365 * 1366 */ 1367 static void xs_data_ready(struct sock *sk) 1368 { 1369 struct rpc_xprt *xprt; 1370 1371 read_lock_bh(&sk->sk_callback_lock); 1372 dprintk("RPC: xs_data_ready...\n"); 1373 xprt = xprt_from_sock(sk); 1374 if (xprt != NULL) { 1375 struct sock_xprt *transport = container_of(xprt, 1376 struct sock_xprt, xprt); 1377 transport->old_data_ready(sk); 1378 /* Any data means we had a useful conversation, so 1379 * then we don't need to delay the next reconnect 1380 */ 1381 if (xprt->reestablish_timeout) 1382 xprt->reestablish_timeout = 0; 1383 if (!test_and_set_bit(XPRT_SOCK_DATA_READY, &transport->sock_state)) 1384 queue_work(xprtiod_workqueue, &transport->recv_worker); 1385 } 1386 read_unlock_bh(&sk->sk_callback_lock); 1387 } 1388 1389 /* 1390 * Helper function to force a TCP close if the server is sending 1391 * junk and/or it has put us in CLOSE_WAIT 1392 */ 1393 static void xs_tcp_force_close(struct rpc_xprt *xprt) 1394 { 1395 xprt_force_disconnect(xprt); 1396 } 1397 1398 #if defined(CONFIG_SUNRPC_BACKCHANNEL) 1399 static int xs_tcp_bc_up(struct svc_serv *serv, struct net *net) 1400 { 1401 int ret; 1402 1403 ret = svc_create_xprt(serv, "tcp-bc", net, PF_INET, 0, 1404 SVC_SOCK_ANONYMOUS); 1405 if (ret < 0) 1406 return ret; 1407 return 0; 1408 } 1409 1410 static size_t xs_tcp_bc_maxpayload(struct rpc_xprt *xprt) 1411 { 1412 return PAGE_SIZE; 1413 } 1414 #endif /* CONFIG_SUNRPC_BACKCHANNEL */ 1415 1416 /** 1417 * xs_tcp_state_change - callback to handle TCP socket state changes 1418 * @sk: socket whose state has changed 1419 * 1420 */ 1421 static void xs_tcp_state_change(struct sock *sk) 1422 { 1423 struct rpc_xprt *xprt; 1424 struct sock_xprt *transport; 1425 1426 read_lock_bh(&sk->sk_callback_lock); 1427 if (!(xprt = xprt_from_sock(sk))) 1428 goto out; 1429 dprintk("RPC: xs_tcp_state_change client %p...\n", xprt); 1430 dprintk("RPC: state %x conn %d dead %d zapped %d sk_shutdown %d\n", 1431 sk->sk_state, xprt_connected(xprt), 1432 sock_flag(sk, SOCK_DEAD), 1433 sock_flag(sk, SOCK_ZAPPED), 1434 sk->sk_shutdown); 1435 1436 transport = container_of(xprt, struct sock_xprt, xprt); 1437 trace_rpc_socket_state_change(xprt, sk->sk_socket); 1438 switch (sk->sk_state) { 1439 case TCP_ESTABLISHED: 1440 spin_lock(&xprt->transport_lock); 1441 if (!xprt_test_and_set_connected(xprt)) { 1442 xprt->connect_cookie++; 1443 clear_bit(XPRT_SOCK_CONNECTING, &transport->sock_state); 1444 xprt_clear_connecting(xprt); 1445 1446 xprt->stat.connect_count++; 1447 xprt->stat.connect_time += (long)jiffies - 1448 xprt->stat.connect_start; 1449 xprt_wake_pending_tasks(xprt, -EAGAIN); 1450 } 1451 spin_unlock(&xprt->transport_lock); 1452 break; 1453 case TCP_FIN_WAIT1: 1454 /* The client initiated a shutdown of the socket */ 1455 xprt->connect_cookie++; 1456 xprt->reestablish_timeout = 0; 1457 set_bit(XPRT_CLOSING, &xprt->state); 1458 smp_mb__before_atomic(); 1459 clear_bit(XPRT_CONNECTED, &xprt->state); 1460 clear_bit(XPRT_CLOSE_WAIT, &xprt->state); 1461 smp_mb__after_atomic(); 1462 break; 1463 case TCP_CLOSE_WAIT: 1464 /* The server initiated a shutdown of the socket */ 1465 xprt->connect_cookie++; 1466 clear_bit(XPRT_CONNECTED, &xprt->state); 1467 xs_tcp_force_close(xprt); 1468 /* fall through */ 1469 case TCP_CLOSING: 1470 /* 1471 * If the server closed down the connection, make sure that 1472 * we back off before reconnecting 1473 */ 1474 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO) 1475 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO; 1476 break; 1477 case TCP_LAST_ACK: 1478 set_bit(XPRT_CLOSING, &xprt->state); 1479 smp_mb__before_atomic(); 1480 clear_bit(XPRT_CONNECTED, &xprt->state); 1481 smp_mb__after_atomic(); 1482 break; 1483 case TCP_CLOSE: 1484 if (test_and_clear_bit(XPRT_SOCK_CONNECTING, 1485 &transport->sock_state)) 1486 xprt_clear_connecting(xprt); 1487 clear_bit(XPRT_CLOSING, &xprt->state); 1488 /* Trigger the socket release */ 1489 xs_tcp_force_close(xprt); 1490 } 1491 out: 1492 read_unlock_bh(&sk->sk_callback_lock); 1493 } 1494 1495 static void xs_write_space(struct sock *sk) 1496 { 1497 struct socket_wq *wq; 1498 struct rpc_xprt *xprt; 1499 1500 if (!sk->sk_socket) 1501 return; 1502 clear_bit(SOCK_NOSPACE, &sk->sk_socket->flags); 1503 1504 if (unlikely(!(xprt = xprt_from_sock(sk)))) 1505 return; 1506 rcu_read_lock(); 1507 wq = rcu_dereference(sk->sk_wq); 1508 if (!wq || test_and_clear_bit(SOCKWQ_ASYNC_NOSPACE, &wq->flags) == 0) 1509 goto out; 1510 1511 if (xprt_write_space(xprt)) 1512 sk->sk_write_pending--; 1513 out: 1514 rcu_read_unlock(); 1515 } 1516 1517 /** 1518 * xs_udp_write_space - callback invoked when socket buffer space 1519 * becomes available 1520 * @sk: socket whose state has changed 1521 * 1522 * Called when more output buffer space is available for this socket. 1523 * We try not to wake our writers until they can make "significant" 1524 * progress, otherwise we'll waste resources thrashing kernel_sendmsg 1525 * with a bunch of small requests. 1526 */ 1527 static void xs_udp_write_space(struct sock *sk) 1528 { 1529 read_lock_bh(&sk->sk_callback_lock); 1530 1531 /* from net/core/sock.c:sock_def_write_space */ 1532 if (sock_writeable(sk)) 1533 xs_write_space(sk); 1534 1535 read_unlock_bh(&sk->sk_callback_lock); 1536 } 1537 1538 /** 1539 * xs_tcp_write_space - callback invoked when socket buffer space 1540 * becomes available 1541 * @sk: socket whose state has changed 1542 * 1543 * Called when more output buffer space is available for this socket. 1544 * We try not to wake our writers until they can make "significant" 1545 * progress, otherwise we'll waste resources thrashing kernel_sendmsg 1546 * with a bunch of small requests. 1547 */ 1548 static void xs_tcp_write_space(struct sock *sk) 1549 { 1550 read_lock_bh(&sk->sk_callback_lock); 1551 1552 /* from net/core/stream.c:sk_stream_write_space */ 1553 if (sk_stream_is_writeable(sk)) 1554 xs_write_space(sk); 1555 1556 read_unlock_bh(&sk->sk_callback_lock); 1557 } 1558 1559 static void xs_udp_do_set_buffer_size(struct rpc_xprt *xprt) 1560 { 1561 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 1562 struct sock *sk = transport->inet; 1563 1564 if (transport->rcvsize) { 1565 sk->sk_userlocks |= SOCK_RCVBUF_LOCK; 1566 sk->sk_rcvbuf = transport->rcvsize * xprt->max_reqs * 2; 1567 } 1568 if (transport->sndsize) { 1569 sk->sk_userlocks |= SOCK_SNDBUF_LOCK; 1570 sk->sk_sndbuf = transport->sndsize * xprt->max_reqs * 2; 1571 sk->sk_write_space(sk); 1572 } 1573 } 1574 1575 /** 1576 * xs_udp_set_buffer_size - set send and receive limits 1577 * @xprt: generic transport 1578 * @sndsize: requested size of send buffer, in bytes 1579 * @rcvsize: requested size of receive buffer, in bytes 1580 * 1581 * Set socket send and receive buffer size limits. 1582 */ 1583 static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize) 1584 { 1585 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 1586 1587 transport->sndsize = 0; 1588 if (sndsize) 1589 transport->sndsize = sndsize + 1024; 1590 transport->rcvsize = 0; 1591 if (rcvsize) 1592 transport->rcvsize = rcvsize + 1024; 1593 1594 xs_udp_do_set_buffer_size(xprt); 1595 } 1596 1597 /** 1598 * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport 1599 * @task: task that timed out 1600 * 1601 * Adjust the congestion window after a retransmit timeout has occurred. 1602 */ 1603 static void xs_udp_timer(struct rpc_xprt *xprt, struct rpc_task *task) 1604 { 1605 spin_lock_bh(&xprt->transport_lock); 1606 xprt_adjust_cwnd(xprt, task, -ETIMEDOUT); 1607 spin_unlock_bh(&xprt->transport_lock); 1608 } 1609 1610 static int xs_get_random_port(void) 1611 { 1612 unsigned short min = xprt_min_resvport, max = xprt_max_resvport; 1613 unsigned short range; 1614 unsigned short rand; 1615 1616 if (max < min) 1617 return -EADDRINUSE; 1618 range = max - min + 1; 1619 rand = (unsigned short) prandom_u32() % range; 1620 return rand + min; 1621 } 1622 1623 /** 1624 * xs_set_reuseaddr_port - set the socket's port and address reuse options 1625 * @sock: socket 1626 * 1627 * Note that this function has to be called on all sockets that share the 1628 * same port, and it must be called before binding. 1629 */ 1630 static void xs_sock_set_reuseport(struct socket *sock) 1631 { 1632 int opt = 1; 1633 1634 kernel_setsockopt(sock, SOL_SOCKET, SO_REUSEPORT, 1635 (char *)&opt, sizeof(opt)); 1636 } 1637 1638 static unsigned short xs_sock_getport(struct socket *sock) 1639 { 1640 struct sockaddr_storage buf; 1641 unsigned short port = 0; 1642 1643 if (kernel_getsockname(sock, (struct sockaddr *)&buf) < 0) 1644 goto out; 1645 switch (buf.ss_family) { 1646 case AF_INET6: 1647 port = ntohs(((struct sockaddr_in6 *)&buf)->sin6_port); 1648 break; 1649 case AF_INET: 1650 port = ntohs(((struct sockaddr_in *)&buf)->sin_port); 1651 } 1652 out: 1653 return port; 1654 } 1655 1656 /** 1657 * xs_set_port - reset the port number in the remote endpoint address 1658 * @xprt: generic transport 1659 * @port: new port number 1660 * 1661 */ 1662 static void xs_set_port(struct rpc_xprt *xprt, unsigned short port) 1663 { 1664 dprintk("RPC: setting port for xprt %p to %u\n", xprt, port); 1665 1666 rpc_set_port(xs_addr(xprt), port); 1667 xs_update_peer_port(xprt); 1668 } 1669 1670 static void xs_set_srcport(struct sock_xprt *transport, struct socket *sock) 1671 { 1672 if (transport->srcport == 0) 1673 transport->srcport = xs_sock_getport(sock); 1674 } 1675 1676 static int xs_get_srcport(struct sock_xprt *transport) 1677 { 1678 int port = transport->srcport; 1679 1680 if (port == 0 && transport->xprt.resvport) 1681 port = xs_get_random_port(); 1682 return port; 1683 } 1684 1685 static unsigned short xs_next_srcport(struct sock_xprt *transport, unsigned short port) 1686 { 1687 if (transport->srcport != 0) 1688 transport->srcport = 0; 1689 if (!transport->xprt.resvport) 1690 return 0; 1691 if (port <= xprt_min_resvport || port > xprt_max_resvport) 1692 return xprt_max_resvport; 1693 return --port; 1694 } 1695 static int xs_bind(struct sock_xprt *transport, struct socket *sock) 1696 { 1697 struct sockaddr_storage myaddr; 1698 int err, nloop = 0; 1699 int port = xs_get_srcport(transport); 1700 unsigned short last; 1701 1702 /* 1703 * If we are asking for any ephemeral port (i.e. port == 0 && 1704 * transport->xprt.resvport == 0), don't bind. Let the local 1705 * port selection happen implicitly when the socket is used 1706 * (for example at connect time). 1707 * 1708 * This ensures that we can continue to establish TCP 1709 * connections even when all local ephemeral ports are already 1710 * a part of some TCP connection. This makes no difference 1711 * for UDP sockets, but also doens't harm them. 1712 * 1713 * If we're asking for any reserved port (i.e. port == 0 && 1714 * transport->xprt.resvport == 1) xs_get_srcport above will 1715 * ensure that port is non-zero and we will bind as needed. 1716 */ 1717 if (port <= 0) 1718 return port; 1719 1720 memcpy(&myaddr, &transport->srcaddr, transport->xprt.addrlen); 1721 do { 1722 rpc_set_port((struct sockaddr *)&myaddr, port); 1723 err = kernel_bind(sock, (struct sockaddr *)&myaddr, 1724 transport->xprt.addrlen); 1725 if (err == 0) { 1726 transport->srcport = port; 1727 break; 1728 } 1729 last = port; 1730 port = xs_next_srcport(transport, port); 1731 if (port > last) 1732 nloop++; 1733 } while (err == -EADDRINUSE && nloop != 2); 1734 1735 if (myaddr.ss_family == AF_INET) 1736 dprintk("RPC: %s %pI4:%u: %s (%d)\n", __func__, 1737 &((struct sockaddr_in *)&myaddr)->sin_addr, 1738 port, err ? "failed" : "ok", err); 1739 else 1740 dprintk("RPC: %s %pI6:%u: %s (%d)\n", __func__, 1741 &((struct sockaddr_in6 *)&myaddr)->sin6_addr, 1742 port, err ? "failed" : "ok", err); 1743 return err; 1744 } 1745 1746 /* 1747 * We don't support autobind on AF_LOCAL sockets 1748 */ 1749 static void xs_local_rpcbind(struct rpc_task *task) 1750 { 1751 xprt_set_bound(task->tk_xprt); 1752 } 1753 1754 static void xs_local_set_port(struct rpc_xprt *xprt, unsigned short port) 1755 { 1756 } 1757 1758 #ifdef CONFIG_DEBUG_LOCK_ALLOC 1759 static struct lock_class_key xs_key[2]; 1760 static struct lock_class_key xs_slock_key[2]; 1761 1762 static inline void xs_reclassify_socketu(struct socket *sock) 1763 { 1764 struct sock *sk = sock->sk; 1765 1766 sock_lock_init_class_and_name(sk, "slock-AF_LOCAL-RPC", 1767 &xs_slock_key[1], "sk_lock-AF_LOCAL-RPC", &xs_key[1]); 1768 } 1769 1770 static inline void xs_reclassify_socket4(struct socket *sock) 1771 { 1772 struct sock *sk = sock->sk; 1773 1774 sock_lock_init_class_and_name(sk, "slock-AF_INET-RPC", 1775 &xs_slock_key[0], "sk_lock-AF_INET-RPC", &xs_key[0]); 1776 } 1777 1778 static inline void xs_reclassify_socket6(struct socket *sock) 1779 { 1780 struct sock *sk = sock->sk; 1781 1782 sock_lock_init_class_and_name(sk, "slock-AF_INET6-RPC", 1783 &xs_slock_key[1], "sk_lock-AF_INET6-RPC", &xs_key[1]); 1784 } 1785 1786 static inline void xs_reclassify_socket(int family, struct socket *sock) 1787 { 1788 if (WARN_ON_ONCE(!sock_allow_reclassification(sock->sk))) 1789 return; 1790 1791 switch (family) { 1792 case AF_LOCAL: 1793 xs_reclassify_socketu(sock); 1794 break; 1795 case AF_INET: 1796 xs_reclassify_socket4(sock); 1797 break; 1798 case AF_INET6: 1799 xs_reclassify_socket6(sock); 1800 break; 1801 } 1802 } 1803 #else 1804 static inline void xs_reclassify_socket(int family, struct socket *sock) 1805 { 1806 } 1807 #endif 1808 1809 static void xs_dummy_setup_socket(struct work_struct *work) 1810 { 1811 } 1812 1813 static struct socket *xs_create_sock(struct rpc_xprt *xprt, 1814 struct sock_xprt *transport, int family, int type, 1815 int protocol, bool reuseport) 1816 { 1817 struct socket *sock; 1818 int err; 1819 1820 err = __sock_create(xprt->xprt_net, family, type, protocol, &sock, 1); 1821 if (err < 0) { 1822 dprintk("RPC: can't create %d transport socket (%d).\n", 1823 protocol, -err); 1824 goto out; 1825 } 1826 xs_reclassify_socket(family, sock); 1827 1828 if (reuseport) 1829 xs_sock_set_reuseport(sock); 1830 1831 err = xs_bind(transport, sock); 1832 if (err) { 1833 sock_release(sock); 1834 goto out; 1835 } 1836 1837 return sock; 1838 out: 1839 return ERR_PTR(err); 1840 } 1841 1842 static int xs_local_finish_connecting(struct rpc_xprt *xprt, 1843 struct socket *sock) 1844 { 1845 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, 1846 xprt); 1847 1848 if (!transport->inet) { 1849 struct sock *sk = sock->sk; 1850 1851 write_lock_bh(&sk->sk_callback_lock); 1852 1853 xs_save_old_callbacks(transport, sk); 1854 1855 sk->sk_user_data = xprt; 1856 sk->sk_data_ready = xs_data_ready; 1857 sk->sk_write_space = xs_udp_write_space; 1858 sock_set_flag(sk, SOCK_FASYNC); 1859 sk->sk_error_report = xs_error_report; 1860 sk->sk_allocation = GFP_NOIO; 1861 1862 xprt_clear_connected(xprt); 1863 1864 /* Reset to new socket */ 1865 transport->sock = sock; 1866 transport->inet = sk; 1867 1868 write_unlock_bh(&sk->sk_callback_lock); 1869 } 1870 1871 xs_stream_reset_connect(transport); 1872 1873 return kernel_connect(sock, xs_addr(xprt), xprt->addrlen, 0); 1874 } 1875 1876 /** 1877 * xs_local_setup_socket - create AF_LOCAL socket, connect to a local endpoint 1878 * @transport: socket transport to connect 1879 */ 1880 static int xs_local_setup_socket(struct sock_xprt *transport) 1881 { 1882 struct rpc_xprt *xprt = &transport->xprt; 1883 struct socket *sock; 1884 int status = -EIO; 1885 1886 status = __sock_create(xprt->xprt_net, AF_LOCAL, 1887 SOCK_STREAM, 0, &sock, 1); 1888 if (status < 0) { 1889 dprintk("RPC: can't create AF_LOCAL " 1890 "transport socket (%d).\n", -status); 1891 goto out; 1892 } 1893 xs_reclassify_socket(AF_LOCAL, sock); 1894 1895 dprintk("RPC: worker connecting xprt %p via AF_LOCAL to %s\n", 1896 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]); 1897 1898 status = xs_local_finish_connecting(xprt, sock); 1899 trace_rpc_socket_connect(xprt, sock, status); 1900 switch (status) { 1901 case 0: 1902 dprintk("RPC: xprt %p connected to %s\n", 1903 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]); 1904 xprt->stat.connect_count++; 1905 xprt->stat.connect_time += (long)jiffies - 1906 xprt->stat.connect_start; 1907 xprt_set_connected(xprt); 1908 case -ENOBUFS: 1909 break; 1910 case -ENOENT: 1911 dprintk("RPC: xprt %p: socket %s does not exist\n", 1912 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]); 1913 break; 1914 case -ECONNREFUSED: 1915 dprintk("RPC: xprt %p: connection refused for %s\n", 1916 xprt, xprt->address_strings[RPC_DISPLAY_ADDR]); 1917 break; 1918 default: 1919 printk(KERN_ERR "%s: unhandled error (%d) connecting to %s\n", 1920 __func__, -status, 1921 xprt->address_strings[RPC_DISPLAY_ADDR]); 1922 } 1923 1924 out: 1925 xprt_clear_connecting(xprt); 1926 xprt_wake_pending_tasks(xprt, status); 1927 return status; 1928 } 1929 1930 static void xs_local_connect(struct rpc_xprt *xprt, struct rpc_task *task) 1931 { 1932 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 1933 int ret; 1934 1935 if (RPC_IS_ASYNC(task)) { 1936 /* 1937 * We want the AF_LOCAL connect to be resolved in the 1938 * filesystem namespace of the process making the rpc 1939 * call. Thus we connect synchronously. 1940 * 1941 * If we want to support asynchronous AF_LOCAL calls, 1942 * we'll need to figure out how to pass a namespace to 1943 * connect. 1944 */ 1945 rpc_exit(task, -ENOTCONN); 1946 return; 1947 } 1948 ret = xs_local_setup_socket(transport); 1949 if (ret && !RPC_IS_SOFTCONN(task)) 1950 msleep_interruptible(15000); 1951 } 1952 1953 #if IS_ENABLED(CONFIG_SUNRPC_SWAP) 1954 /* 1955 * Note that this should be called with XPRT_LOCKED held (or when we otherwise 1956 * know that we have exclusive access to the socket), to guard against 1957 * races with xs_reset_transport. 1958 */ 1959 static void xs_set_memalloc(struct rpc_xprt *xprt) 1960 { 1961 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, 1962 xprt); 1963 1964 /* 1965 * If there's no sock, then we have nothing to set. The 1966 * reconnecting process will get it for us. 1967 */ 1968 if (!transport->inet) 1969 return; 1970 if (atomic_read(&xprt->swapper)) 1971 sk_set_memalloc(transport->inet); 1972 } 1973 1974 /** 1975 * xs_enable_swap - Tag this transport as being used for swap. 1976 * @xprt: transport to tag 1977 * 1978 * Take a reference to this transport on behalf of the rpc_clnt, and 1979 * optionally mark it for swapping if it wasn't already. 1980 */ 1981 static int 1982 xs_enable_swap(struct rpc_xprt *xprt) 1983 { 1984 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt); 1985 1986 if (atomic_inc_return(&xprt->swapper) != 1) 1987 return 0; 1988 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE)) 1989 return -ERESTARTSYS; 1990 if (xs->inet) 1991 sk_set_memalloc(xs->inet); 1992 xprt_release_xprt(xprt, NULL); 1993 return 0; 1994 } 1995 1996 /** 1997 * xs_disable_swap - Untag this transport as being used for swap. 1998 * @xprt: transport to tag 1999 * 2000 * Drop a "swapper" reference to this xprt on behalf of the rpc_clnt. If the 2001 * swapper refcount goes to 0, untag the socket as a memalloc socket. 2002 */ 2003 static void 2004 xs_disable_swap(struct rpc_xprt *xprt) 2005 { 2006 struct sock_xprt *xs = container_of(xprt, struct sock_xprt, xprt); 2007 2008 if (!atomic_dec_and_test(&xprt->swapper)) 2009 return; 2010 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE)) 2011 return; 2012 if (xs->inet) 2013 sk_clear_memalloc(xs->inet); 2014 xprt_release_xprt(xprt, NULL); 2015 } 2016 #else 2017 static void xs_set_memalloc(struct rpc_xprt *xprt) 2018 { 2019 } 2020 2021 static int 2022 xs_enable_swap(struct rpc_xprt *xprt) 2023 { 2024 return -EINVAL; 2025 } 2026 2027 static void 2028 xs_disable_swap(struct rpc_xprt *xprt) 2029 { 2030 } 2031 #endif 2032 2033 static void xs_udp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock) 2034 { 2035 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 2036 2037 if (!transport->inet) { 2038 struct sock *sk = sock->sk; 2039 2040 write_lock_bh(&sk->sk_callback_lock); 2041 2042 xs_save_old_callbacks(transport, sk); 2043 2044 sk->sk_user_data = xprt; 2045 sk->sk_data_ready = xs_data_ready; 2046 sk->sk_write_space = xs_udp_write_space; 2047 sock_set_flag(sk, SOCK_FASYNC); 2048 sk->sk_allocation = GFP_NOIO; 2049 2050 xprt_set_connected(xprt); 2051 2052 /* Reset to new socket */ 2053 transport->sock = sock; 2054 transport->inet = sk; 2055 2056 xs_set_memalloc(xprt); 2057 2058 write_unlock_bh(&sk->sk_callback_lock); 2059 } 2060 xs_udp_do_set_buffer_size(xprt); 2061 2062 xprt->stat.connect_start = jiffies; 2063 } 2064 2065 static void xs_udp_setup_socket(struct work_struct *work) 2066 { 2067 struct sock_xprt *transport = 2068 container_of(work, struct sock_xprt, connect_worker.work); 2069 struct rpc_xprt *xprt = &transport->xprt; 2070 struct socket *sock; 2071 int status = -EIO; 2072 2073 sock = xs_create_sock(xprt, transport, 2074 xs_addr(xprt)->sa_family, SOCK_DGRAM, 2075 IPPROTO_UDP, false); 2076 if (IS_ERR(sock)) 2077 goto out; 2078 2079 dprintk("RPC: worker connecting xprt %p via %s to " 2080 "%s (port %s)\n", xprt, 2081 xprt->address_strings[RPC_DISPLAY_PROTO], 2082 xprt->address_strings[RPC_DISPLAY_ADDR], 2083 xprt->address_strings[RPC_DISPLAY_PORT]); 2084 2085 xs_udp_finish_connecting(xprt, sock); 2086 trace_rpc_socket_connect(xprt, sock, 0); 2087 status = 0; 2088 out: 2089 xprt_clear_connecting(xprt); 2090 xprt_unlock_connect(xprt, transport); 2091 xprt_wake_pending_tasks(xprt, status); 2092 } 2093 2094 /** 2095 * xs_tcp_shutdown - gracefully shut down a TCP socket 2096 * @xprt: transport 2097 * 2098 * Initiates a graceful shutdown of the TCP socket by calling the 2099 * equivalent of shutdown(SHUT_RDWR); 2100 */ 2101 static void xs_tcp_shutdown(struct rpc_xprt *xprt) 2102 { 2103 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 2104 struct socket *sock = transport->sock; 2105 int skst = transport->inet ? transport->inet->sk_state : TCP_CLOSE; 2106 2107 if (sock == NULL) 2108 return; 2109 switch (skst) { 2110 default: 2111 kernel_sock_shutdown(sock, SHUT_RDWR); 2112 trace_rpc_socket_shutdown(xprt, sock); 2113 break; 2114 case TCP_CLOSE: 2115 case TCP_TIME_WAIT: 2116 xs_reset_transport(transport); 2117 } 2118 } 2119 2120 static void xs_tcp_set_socket_timeouts(struct rpc_xprt *xprt, 2121 struct socket *sock) 2122 { 2123 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 2124 unsigned int keepidle; 2125 unsigned int keepcnt; 2126 unsigned int opt_on = 1; 2127 unsigned int timeo; 2128 2129 spin_lock_bh(&xprt->transport_lock); 2130 keepidle = DIV_ROUND_UP(xprt->timeout->to_initval, HZ); 2131 keepcnt = xprt->timeout->to_retries + 1; 2132 timeo = jiffies_to_msecs(xprt->timeout->to_initval) * 2133 (xprt->timeout->to_retries + 1); 2134 clear_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state); 2135 spin_unlock_bh(&xprt->transport_lock); 2136 2137 /* TCP Keepalive options */ 2138 kernel_setsockopt(sock, SOL_SOCKET, SO_KEEPALIVE, 2139 (char *)&opt_on, sizeof(opt_on)); 2140 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPIDLE, 2141 (char *)&keepidle, sizeof(keepidle)); 2142 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPINTVL, 2143 (char *)&keepidle, sizeof(keepidle)); 2144 kernel_setsockopt(sock, SOL_TCP, TCP_KEEPCNT, 2145 (char *)&keepcnt, sizeof(keepcnt)); 2146 2147 /* TCP user timeout (see RFC5482) */ 2148 kernel_setsockopt(sock, SOL_TCP, TCP_USER_TIMEOUT, 2149 (char *)&timeo, sizeof(timeo)); 2150 } 2151 2152 static void xs_tcp_set_connect_timeout(struct rpc_xprt *xprt, 2153 unsigned long connect_timeout, 2154 unsigned long reconnect_timeout) 2155 { 2156 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 2157 struct rpc_timeout to; 2158 unsigned long initval; 2159 2160 spin_lock_bh(&xprt->transport_lock); 2161 if (reconnect_timeout < xprt->max_reconnect_timeout) 2162 xprt->max_reconnect_timeout = reconnect_timeout; 2163 if (connect_timeout < xprt->connect_timeout) { 2164 memcpy(&to, xprt->timeout, sizeof(to)); 2165 initval = DIV_ROUND_UP(connect_timeout, to.to_retries + 1); 2166 /* Arbitrary lower limit */ 2167 if (initval < XS_TCP_INIT_REEST_TO << 1) 2168 initval = XS_TCP_INIT_REEST_TO << 1; 2169 to.to_initval = initval; 2170 to.to_maxval = initval; 2171 memcpy(&transport->tcp_timeout, &to, 2172 sizeof(transport->tcp_timeout)); 2173 xprt->timeout = &transport->tcp_timeout; 2174 xprt->connect_timeout = connect_timeout; 2175 } 2176 set_bit(XPRT_SOCK_UPD_TIMEOUT, &transport->sock_state); 2177 spin_unlock_bh(&xprt->transport_lock); 2178 } 2179 2180 static int xs_tcp_finish_connecting(struct rpc_xprt *xprt, struct socket *sock) 2181 { 2182 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 2183 int ret = -ENOTCONN; 2184 2185 if (!transport->inet) { 2186 struct sock *sk = sock->sk; 2187 unsigned int addr_pref = IPV6_PREFER_SRC_PUBLIC; 2188 2189 /* Avoid temporary address, they are bad for long-lived 2190 * connections such as NFS mounts. 2191 * RFC4941, section 3.6 suggests that: 2192 * Individual applications, which have specific 2193 * knowledge about the normal duration of connections, 2194 * MAY override this as appropriate. 2195 */ 2196 kernel_setsockopt(sock, SOL_IPV6, IPV6_ADDR_PREFERENCES, 2197 (char *)&addr_pref, sizeof(addr_pref)); 2198 2199 xs_tcp_set_socket_timeouts(xprt, sock); 2200 2201 write_lock_bh(&sk->sk_callback_lock); 2202 2203 xs_save_old_callbacks(transport, sk); 2204 2205 sk->sk_user_data = xprt; 2206 sk->sk_data_ready = xs_data_ready; 2207 sk->sk_state_change = xs_tcp_state_change; 2208 sk->sk_write_space = xs_tcp_write_space; 2209 sock_set_flag(sk, SOCK_FASYNC); 2210 sk->sk_error_report = xs_error_report; 2211 sk->sk_allocation = GFP_NOIO; 2212 2213 /* socket options */ 2214 sock_reset_flag(sk, SOCK_LINGER); 2215 tcp_sk(sk)->nonagle |= TCP_NAGLE_OFF; 2216 2217 xprt_clear_connected(xprt); 2218 2219 /* Reset to new socket */ 2220 transport->sock = sock; 2221 transport->inet = sk; 2222 2223 write_unlock_bh(&sk->sk_callback_lock); 2224 } 2225 2226 if (!xprt_bound(xprt)) 2227 goto out; 2228 2229 xs_set_memalloc(xprt); 2230 2231 /* Reset TCP record info */ 2232 xs_stream_reset_connect(transport); 2233 2234 /* Tell the socket layer to start connecting... */ 2235 set_bit(XPRT_SOCK_CONNECTING, &transport->sock_state); 2236 ret = kernel_connect(sock, xs_addr(xprt), xprt->addrlen, O_NONBLOCK); 2237 switch (ret) { 2238 case 0: 2239 xs_set_srcport(transport, sock); 2240 /* fall through */ 2241 case -EINPROGRESS: 2242 /* SYN_SENT! */ 2243 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO) 2244 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO; 2245 break; 2246 case -EADDRNOTAVAIL: 2247 /* Source port number is unavailable. Try a new one! */ 2248 transport->srcport = 0; 2249 } 2250 out: 2251 return ret; 2252 } 2253 2254 /** 2255 * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint 2256 * 2257 * Invoked by a work queue tasklet. 2258 */ 2259 static void xs_tcp_setup_socket(struct work_struct *work) 2260 { 2261 struct sock_xprt *transport = 2262 container_of(work, struct sock_xprt, connect_worker.work); 2263 struct socket *sock = transport->sock; 2264 struct rpc_xprt *xprt = &transport->xprt; 2265 int status = -EIO; 2266 2267 if (!sock) { 2268 sock = xs_create_sock(xprt, transport, 2269 xs_addr(xprt)->sa_family, SOCK_STREAM, 2270 IPPROTO_TCP, true); 2271 if (IS_ERR(sock)) { 2272 status = PTR_ERR(sock); 2273 goto out; 2274 } 2275 } 2276 2277 dprintk("RPC: worker connecting xprt %p via %s to " 2278 "%s (port %s)\n", xprt, 2279 xprt->address_strings[RPC_DISPLAY_PROTO], 2280 xprt->address_strings[RPC_DISPLAY_ADDR], 2281 xprt->address_strings[RPC_DISPLAY_PORT]); 2282 2283 status = xs_tcp_finish_connecting(xprt, sock); 2284 trace_rpc_socket_connect(xprt, sock, status); 2285 dprintk("RPC: %p connect status %d connected %d sock state %d\n", 2286 xprt, -status, xprt_connected(xprt), 2287 sock->sk->sk_state); 2288 switch (status) { 2289 default: 2290 printk("%s: connect returned unhandled error %d\n", 2291 __func__, status); 2292 /* fall through */ 2293 case -EADDRNOTAVAIL: 2294 /* We're probably in TIME_WAIT. Get rid of existing socket, 2295 * and retry 2296 */ 2297 xs_tcp_force_close(xprt); 2298 break; 2299 case 0: 2300 case -EINPROGRESS: 2301 case -EALREADY: 2302 xprt_unlock_connect(xprt, transport); 2303 return; 2304 case -EINVAL: 2305 /* Happens, for instance, if the user specified a link 2306 * local IPv6 address without a scope-id. 2307 */ 2308 case -ECONNREFUSED: 2309 case -ECONNRESET: 2310 case -ENETDOWN: 2311 case -ENETUNREACH: 2312 case -EHOSTUNREACH: 2313 case -EADDRINUSE: 2314 case -ENOBUFS: 2315 /* 2316 * xs_tcp_force_close() wakes tasks with -EIO. 2317 * We need to wake them first to ensure the 2318 * correct error code. 2319 */ 2320 xprt_wake_pending_tasks(xprt, status); 2321 xs_tcp_force_close(xprt); 2322 goto out; 2323 } 2324 status = -EAGAIN; 2325 out: 2326 xprt_clear_connecting(xprt); 2327 xprt_unlock_connect(xprt, transport); 2328 xprt_wake_pending_tasks(xprt, status); 2329 } 2330 2331 static unsigned long xs_reconnect_delay(const struct rpc_xprt *xprt) 2332 { 2333 unsigned long start, now = jiffies; 2334 2335 start = xprt->stat.connect_start + xprt->reestablish_timeout; 2336 if (time_after(start, now)) 2337 return start - now; 2338 return 0; 2339 } 2340 2341 static void xs_reconnect_backoff(struct rpc_xprt *xprt) 2342 { 2343 xprt->reestablish_timeout <<= 1; 2344 if (xprt->reestablish_timeout > xprt->max_reconnect_timeout) 2345 xprt->reestablish_timeout = xprt->max_reconnect_timeout; 2346 if (xprt->reestablish_timeout < XS_TCP_INIT_REEST_TO) 2347 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO; 2348 } 2349 2350 /** 2351 * xs_connect - connect a socket to a remote endpoint 2352 * @xprt: pointer to transport structure 2353 * @task: address of RPC task that manages state of connect request 2354 * 2355 * TCP: If the remote end dropped the connection, delay reconnecting. 2356 * 2357 * UDP socket connects are synchronous, but we use a work queue anyway 2358 * to guarantee that even unprivileged user processes can set up a 2359 * socket on a privileged port. 2360 * 2361 * If a UDP socket connect fails, the delay behavior here prevents 2362 * retry floods (hard mounts). 2363 */ 2364 static void xs_connect(struct rpc_xprt *xprt, struct rpc_task *task) 2365 { 2366 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 2367 unsigned long delay = 0; 2368 2369 WARN_ON_ONCE(!xprt_lock_connect(xprt, task, transport)); 2370 2371 if (transport->sock != NULL) { 2372 dprintk("RPC: xs_connect delayed xprt %p for %lu " 2373 "seconds\n", 2374 xprt, xprt->reestablish_timeout / HZ); 2375 2376 /* Start by resetting any existing state */ 2377 xs_reset_transport(transport); 2378 2379 delay = xs_reconnect_delay(xprt); 2380 xs_reconnect_backoff(xprt); 2381 2382 } else 2383 dprintk("RPC: xs_connect scheduled xprt %p\n", xprt); 2384 2385 queue_delayed_work(xprtiod_workqueue, 2386 &transport->connect_worker, 2387 delay); 2388 } 2389 2390 /** 2391 * xs_local_print_stats - display AF_LOCAL socket-specifc stats 2392 * @xprt: rpc_xprt struct containing statistics 2393 * @seq: output file 2394 * 2395 */ 2396 static void xs_local_print_stats(struct rpc_xprt *xprt, struct seq_file *seq) 2397 { 2398 long idle_time = 0; 2399 2400 if (xprt_connected(xprt)) 2401 idle_time = (long)(jiffies - xprt->last_used) / HZ; 2402 2403 seq_printf(seq, "\txprt:\tlocal %lu %lu %lu %ld %lu %lu %lu " 2404 "%llu %llu %lu %llu %llu\n", 2405 xprt->stat.bind_count, 2406 xprt->stat.connect_count, 2407 xprt->stat.connect_time / HZ, 2408 idle_time, 2409 xprt->stat.sends, 2410 xprt->stat.recvs, 2411 xprt->stat.bad_xids, 2412 xprt->stat.req_u, 2413 xprt->stat.bklog_u, 2414 xprt->stat.max_slots, 2415 xprt->stat.sending_u, 2416 xprt->stat.pending_u); 2417 } 2418 2419 /** 2420 * xs_udp_print_stats - display UDP socket-specifc stats 2421 * @xprt: rpc_xprt struct containing statistics 2422 * @seq: output file 2423 * 2424 */ 2425 static void xs_udp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq) 2426 { 2427 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 2428 2429 seq_printf(seq, "\txprt:\tudp %u %lu %lu %lu %lu %llu %llu " 2430 "%lu %llu %llu\n", 2431 transport->srcport, 2432 xprt->stat.bind_count, 2433 xprt->stat.sends, 2434 xprt->stat.recvs, 2435 xprt->stat.bad_xids, 2436 xprt->stat.req_u, 2437 xprt->stat.bklog_u, 2438 xprt->stat.max_slots, 2439 xprt->stat.sending_u, 2440 xprt->stat.pending_u); 2441 } 2442 2443 /** 2444 * xs_tcp_print_stats - display TCP socket-specifc stats 2445 * @xprt: rpc_xprt struct containing statistics 2446 * @seq: output file 2447 * 2448 */ 2449 static void xs_tcp_print_stats(struct rpc_xprt *xprt, struct seq_file *seq) 2450 { 2451 struct sock_xprt *transport = container_of(xprt, struct sock_xprt, xprt); 2452 long idle_time = 0; 2453 2454 if (xprt_connected(xprt)) 2455 idle_time = (long)(jiffies - xprt->last_used) / HZ; 2456 2457 seq_printf(seq, "\txprt:\ttcp %u %lu %lu %lu %ld %lu %lu %lu " 2458 "%llu %llu %lu %llu %llu\n", 2459 transport->srcport, 2460 xprt->stat.bind_count, 2461 xprt->stat.connect_count, 2462 xprt->stat.connect_time / HZ, 2463 idle_time, 2464 xprt->stat.sends, 2465 xprt->stat.recvs, 2466 xprt->stat.bad_xids, 2467 xprt->stat.req_u, 2468 xprt->stat.bklog_u, 2469 xprt->stat.max_slots, 2470 xprt->stat.sending_u, 2471 xprt->stat.pending_u); 2472 } 2473 2474 /* 2475 * Allocate a bunch of pages for a scratch buffer for the rpc code. The reason 2476 * we allocate pages instead doing a kmalloc like rpc_malloc is because we want 2477 * to use the server side send routines. 2478 */ 2479 static int bc_malloc(struct rpc_task *task) 2480 { 2481 struct rpc_rqst *rqst = task->tk_rqstp; 2482 size_t size = rqst->rq_callsize; 2483 struct page *page; 2484 struct rpc_buffer *buf; 2485 2486 if (size > PAGE_SIZE - sizeof(struct rpc_buffer)) { 2487 WARN_ONCE(1, "xprtsock: large bc buffer request (size %zu)\n", 2488 size); 2489 return -EINVAL; 2490 } 2491 2492 page = alloc_page(GFP_KERNEL); 2493 if (!page) 2494 return -ENOMEM; 2495 2496 buf = page_address(page); 2497 buf->len = PAGE_SIZE; 2498 2499 rqst->rq_buffer = buf->data; 2500 rqst->rq_rbuffer = (char *)rqst->rq_buffer + rqst->rq_callsize; 2501 return 0; 2502 } 2503 2504 /* 2505 * Free the space allocated in the bc_alloc routine 2506 */ 2507 static void bc_free(struct rpc_task *task) 2508 { 2509 void *buffer = task->tk_rqstp->rq_buffer; 2510 struct rpc_buffer *buf; 2511 2512 buf = container_of(buffer, struct rpc_buffer, data); 2513 free_page((unsigned long)buf); 2514 } 2515 2516 /* 2517 * Use the svc_sock to send the callback. Must be called with svsk->sk_mutex 2518 * held. Borrows heavily from svc_tcp_sendto and xs_tcp_send_request. 2519 */ 2520 static int bc_sendto(struct rpc_rqst *req) 2521 { 2522 int len; 2523 struct xdr_buf *xbufp = &req->rq_snd_buf; 2524 struct rpc_xprt *xprt = req->rq_xprt; 2525 struct sock_xprt *transport = 2526 container_of(xprt, struct sock_xprt, xprt); 2527 struct socket *sock = transport->sock; 2528 unsigned long headoff; 2529 unsigned long tailoff; 2530 2531 xs_encode_stream_record_marker(xbufp); 2532 2533 tailoff = (unsigned long)xbufp->tail[0].iov_base & ~PAGE_MASK; 2534 headoff = (unsigned long)xbufp->head[0].iov_base & ~PAGE_MASK; 2535 len = svc_send_common(sock, xbufp, 2536 virt_to_page(xbufp->head[0].iov_base), headoff, 2537 xbufp->tail[0].iov_base, tailoff); 2538 2539 if (len != xbufp->len) { 2540 printk(KERN_NOTICE "Error sending entire callback!\n"); 2541 len = -EAGAIN; 2542 } 2543 2544 return len; 2545 } 2546 2547 /* 2548 * The send routine. Borrows from svc_send 2549 */ 2550 static int bc_send_request(struct rpc_rqst *req) 2551 { 2552 struct svc_xprt *xprt; 2553 int len; 2554 2555 dprintk("sending request with xid: %08x\n", ntohl(req->rq_xid)); 2556 /* 2557 * Get the server socket associated with this callback xprt 2558 */ 2559 xprt = req->rq_xprt->bc_xprt; 2560 2561 /* 2562 * Grab the mutex to serialize data as the connection is shared 2563 * with the fore channel 2564 */ 2565 mutex_lock(&xprt->xpt_mutex); 2566 if (test_bit(XPT_DEAD, &xprt->xpt_flags)) 2567 len = -ENOTCONN; 2568 else 2569 len = bc_sendto(req); 2570 mutex_unlock(&xprt->xpt_mutex); 2571 2572 if (len > 0) 2573 len = 0; 2574 2575 return len; 2576 } 2577 2578 /* 2579 * The close routine. Since this is client initiated, we do nothing 2580 */ 2581 2582 static void bc_close(struct rpc_xprt *xprt) 2583 { 2584 } 2585 2586 /* 2587 * The xprt destroy routine. Again, because this connection is client 2588 * initiated, we do nothing 2589 */ 2590 2591 static void bc_destroy(struct rpc_xprt *xprt) 2592 { 2593 dprintk("RPC: bc_destroy xprt %p\n", xprt); 2594 2595 xs_xprt_free(xprt); 2596 module_put(THIS_MODULE); 2597 } 2598 2599 static const struct rpc_xprt_ops xs_local_ops = { 2600 .reserve_xprt = xprt_reserve_xprt, 2601 .release_xprt = xprt_release_xprt, 2602 .alloc_slot = xprt_alloc_slot, 2603 .free_slot = xprt_free_slot, 2604 .rpcbind = xs_local_rpcbind, 2605 .set_port = xs_local_set_port, 2606 .connect = xs_local_connect, 2607 .buf_alloc = rpc_malloc, 2608 .buf_free = rpc_free, 2609 .prepare_request = xs_stream_prepare_request, 2610 .send_request = xs_local_send_request, 2611 .set_retrans_timeout = xprt_set_retrans_timeout_def, 2612 .close = xs_close, 2613 .destroy = xs_destroy, 2614 .print_stats = xs_local_print_stats, 2615 .enable_swap = xs_enable_swap, 2616 .disable_swap = xs_disable_swap, 2617 }; 2618 2619 static const struct rpc_xprt_ops xs_udp_ops = { 2620 .set_buffer_size = xs_udp_set_buffer_size, 2621 .reserve_xprt = xprt_reserve_xprt_cong, 2622 .release_xprt = xprt_release_xprt_cong, 2623 .alloc_slot = xprt_alloc_slot, 2624 .free_slot = xprt_free_slot, 2625 .rpcbind = rpcb_getport_async, 2626 .set_port = xs_set_port, 2627 .connect = xs_connect, 2628 .buf_alloc = rpc_malloc, 2629 .buf_free = rpc_free, 2630 .send_request = xs_udp_send_request, 2631 .set_retrans_timeout = xprt_set_retrans_timeout_rtt, 2632 .timer = xs_udp_timer, 2633 .release_request = xprt_release_rqst_cong, 2634 .close = xs_close, 2635 .destroy = xs_destroy, 2636 .print_stats = xs_udp_print_stats, 2637 .enable_swap = xs_enable_swap, 2638 .disable_swap = xs_disable_swap, 2639 .inject_disconnect = xs_inject_disconnect, 2640 }; 2641 2642 static const struct rpc_xprt_ops xs_tcp_ops = { 2643 .reserve_xprt = xprt_reserve_xprt, 2644 .release_xprt = xprt_release_xprt, 2645 .alloc_slot = xprt_alloc_slot, 2646 .free_slot = xprt_free_slot, 2647 .rpcbind = rpcb_getport_async, 2648 .set_port = xs_set_port, 2649 .connect = xs_connect, 2650 .buf_alloc = rpc_malloc, 2651 .buf_free = rpc_free, 2652 .prepare_request = xs_stream_prepare_request, 2653 .send_request = xs_tcp_send_request, 2654 .set_retrans_timeout = xprt_set_retrans_timeout_def, 2655 .close = xs_tcp_shutdown, 2656 .destroy = xs_destroy, 2657 .set_connect_timeout = xs_tcp_set_connect_timeout, 2658 .print_stats = xs_tcp_print_stats, 2659 .enable_swap = xs_enable_swap, 2660 .disable_swap = xs_disable_swap, 2661 .inject_disconnect = xs_inject_disconnect, 2662 #ifdef CONFIG_SUNRPC_BACKCHANNEL 2663 .bc_setup = xprt_setup_bc, 2664 .bc_up = xs_tcp_bc_up, 2665 .bc_maxpayload = xs_tcp_bc_maxpayload, 2666 .bc_free_rqst = xprt_free_bc_rqst, 2667 .bc_destroy = xprt_destroy_bc, 2668 #endif 2669 }; 2670 2671 /* 2672 * The rpc_xprt_ops for the server backchannel 2673 */ 2674 2675 static const struct rpc_xprt_ops bc_tcp_ops = { 2676 .reserve_xprt = xprt_reserve_xprt, 2677 .release_xprt = xprt_release_xprt, 2678 .alloc_slot = xprt_alloc_slot, 2679 .free_slot = xprt_free_slot, 2680 .buf_alloc = bc_malloc, 2681 .buf_free = bc_free, 2682 .send_request = bc_send_request, 2683 .set_retrans_timeout = xprt_set_retrans_timeout_def, 2684 .close = bc_close, 2685 .destroy = bc_destroy, 2686 .print_stats = xs_tcp_print_stats, 2687 .enable_swap = xs_enable_swap, 2688 .disable_swap = xs_disable_swap, 2689 .inject_disconnect = xs_inject_disconnect, 2690 }; 2691 2692 static int xs_init_anyaddr(const int family, struct sockaddr *sap) 2693 { 2694 static const struct sockaddr_in sin = { 2695 .sin_family = AF_INET, 2696 .sin_addr.s_addr = htonl(INADDR_ANY), 2697 }; 2698 static const struct sockaddr_in6 sin6 = { 2699 .sin6_family = AF_INET6, 2700 .sin6_addr = IN6ADDR_ANY_INIT, 2701 }; 2702 2703 switch (family) { 2704 case AF_LOCAL: 2705 break; 2706 case AF_INET: 2707 memcpy(sap, &sin, sizeof(sin)); 2708 break; 2709 case AF_INET6: 2710 memcpy(sap, &sin6, sizeof(sin6)); 2711 break; 2712 default: 2713 dprintk("RPC: %s: Bad address family\n", __func__); 2714 return -EAFNOSUPPORT; 2715 } 2716 return 0; 2717 } 2718 2719 static struct rpc_xprt *xs_setup_xprt(struct xprt_create *args, 2720 unsigned int slot_table_size, 2721 unsigned int max_slot_table_size) 2722 { 2723 struct rpc_xprt *xprt; 2724 struct sock_xprt *new; 2725 2726 if (args->addrlen > sizeof(xprt->addr)) { 2727 dprintk("RPC: xs_setup_xprt: address too large\n"); 2728 return ERR_PTR(-EBADF); 2729 } 2730 2731 xprt = xprt_alloc(args->net, sizeof(*new), slot_table_size, 2732 max_slot_table_size); 2733 if (xprt == NULL) { 2734 dprintk("RPC: xs_setup_xprt: couldn't allocate " 2735 "rpc_xprt\n"); 2736 return ERR_PTR(-ENOMEM); 2737 } 2738 2739 new = container_of(xprt, struct sock_xprt, xprt); 2740 mutex_init(&new->recv_mutex); 2741 memcpy(&xprt->addr, args->dstaddr, args->addrlen); 2742 xprt->addrlen = args->addrlen; 2743 if (args->srcaddr) 2744 memcpy(&new->srcaddr, args->srcaddr, args->addrlen); 2745 else { 2746 int err; 2747 err = xs_init_anyaddr(args->dstaddr->sa_family, 2748 (struct sockaddr *)&new->srcaddr); 2749 if (err != 0) { 2750 xprt_free(xprt); 2751 return ERR_PTR(err); 2752 } 2753 } 2754 2755 return xprt; 2756 } 2757 2758 static const struct rpc_timeout xs_local_default_timeout = { 2759 .to_initval = 10 * HZ, 2760 .to_maxval = 10 * HZ, 2761 .to_retries = 2, 2762 }; 2763 2764 /** 2765 * xs_setup_local - Set up transport to use an AF_LOCAL socket 2766 * @args: rpc transport creation arguments 2767 * 2768 * AF_LOCAL is a "tpi_cots_ord" transport, just like TCP 2769 */ 2770 static struct rpc_xprt *xs_setup_local(struct xprt_create *args) 2771 { 2772 struct sockaddr_un *sun = (struct sockaddr_un *)args->dstaddr; 2773 struct sock_xprt *transport; 2774 struct rpc_xprt *xprt; 2775 struct rpc_xprt *ret; 2776 2777 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries, 2778 xprt_max_tcp_slot_table_entries); 2779 if (IS_ERR(xprt)) 2780 return xprt; 2781 transport = container_of(xprt, struct sock_xprt, xprt); 2782 2783 xprt->prot = 0; 2784 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32); 2785 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE; 2786 2787 xprt->bind_timeout = XS_BIND_TO; 2788 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO; 2789 xprt->idle_timeout = XS_IDLE_DISC_TO; 2790 2791 xprt->ops = &xs_local_ops; 2792 xprt->timeout = &xs_local_default_timeout; 2793 2794 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn); 2795 INIT_DELAYED_WORK(&transport->connect_worker, xs_dummy_setup_socket); 2796 2797 switch (sun->sun_family) { 2798 case AF_LOCAL: 2799 if (sun->sun_path[0] != '/') { 2800 dprintk("RPC: bad AF_LOCAL address: %s\n", 2801 sun->sun_path); 2802 ret = ERR_PTR(-EINVAL); 2803 goto out_err; 2804 } 2805 xprt_set_bound(xprt); 2806 xs_format_peer_addresses(xprt, "local", RPCBIND_NETID_LOCAL); 2807 ret = ERR_PTR(xs_local_setup_socket(transport)); 2808 if (ret) 2809 goto out_err; 2810 break; 2811 default: 2812 ret = ERR_PTR(-EAFNOSUPPORT); 2813 goto out_err; 2814 } 2815 2816 dprintk("RPC: set up xprt to %s via AF_LOCAL\n", 2817 xprt->address_strings[RPC_DISPLAY_ADDR]); 2818 2819 if (try_module_get(THIS_MODULE)) 2820 return xprt; 2821 ret = ERR_PTR(-EINVAL); 2822 out_err: 2823 xs_xprt_free(xprt); 2824 return ret; 2825 } 2826 2827 static const struct rpc_timeout xs_udp_default_timeout = { 2828 .to_initval = 5 * HZ, 2829 .to_maxval = 30 * HZ, 2830 .to_increment = 5 * HZ, 2831 .to_retries = 5, 2832 }; 2833 2834 /** 2835 * xs_setup_udp - Set up transport to use a UDP socket 2836 * @args: rpc transport creation arguments 2837 * 2838 */ 2839 static struct rpc_xprt *xs_setup_udp(struct xprt_create *args) 2840 { 2841 struct sockaddr *addr = args->dstaddr; 2842 struct rpc_xprt *xprt; 2843 struct sock_xprt *transport; 2844 struct rpc_xprt *ret; 2845 2846 xprt = xs_setup_xprt(args, xprt_udp_slot_table_entries, 2847 xprt_udp_slot_table_entries); 2848 if (IS_ERR(xprt)) 2849 return xprt; 2850 transport = container_of(xprt, struct sock_xprt, xprt); 2851 2852 xprt->prot = IPPROTO_UDP; 2853 xprt->tsh_size = 0; 2854 /* XXX: header size can vary due to auth type, IPv6, etc. */ 2855 xprt->max_payload = (1U << 16) - (MAX_HEADER << 3); 2856 2857 xprt->bind_timeout = XS_BIND_TO; 2858 xprt->reestablish_timeout = XS_UDP_REEST_TO; 2859 xprt->idle_timeout = XS_IDLE_DISC_TO; 2860 2861 xprt->ops = &xs_udp_ops; 2862 2863 xprt->timeout = &xs_udp_default_timeout; 2864 2865 INIT_WORK(&transport->recv_worker, xs_udp_data_receive_workfn); 2866 INIT_DELAYED_WORK(&transport->connect_worker, xs_udp_setup_socket); 2867 2868 switch (addr->sa_family) { 2869 case AF_INET: 2870 if (((struct sockaddr_in *)addr)->sin_port != htons(0)) 2871 xprt_set_bound(xprt); 2872 2873 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP); 2874 break; 2875 case AF_INET6: 2876 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0)) 2877 xprt_set_bound(xprt); 2878 2879 xs_format_peer_addresses(xprt, "udp", RPCBIND_NETID_UDP6); 2880 break; 2881 default: 2882 ret = ERR_PTR(-EAFNOSUPPORT); 2883 goto out_err; 2884 } 2885 2886 if (xprt_bound(xprt)) 2887 dprintk("RPC: set up xprt to %s (port %s) via %s\n", 2888 xprt->address_strings[RPC_DISPLAY_ADDR], 2889 xprt->address_strings[RPC_DISPLAY_PORT], 2890 xprt->address_strings[RPC_DISPLAY_PROTO]); 2891 else 2892 dprintk("RPC: set up xprt to %s (autobind) via %s\n", 2893 xprt->address_strings[RPC_DISPLAY_ADDR], 2894 xprt->address_strings[RPC_DISPLAY_PROTO]); 2895 2896 if (try_module_get(THIS_MODULE)) 2897 return xprt; 2898 ret = ERR_PTR(-EINVAL); 2899 out_err: 2900 xs_xprt_free(xprt); 2901 return ret; 2902 } 2903 2904 static const struct rpc_timeout xs_tcp_default_timeout = { 2905 .to_initval = 60 * HZ, 2906 .to_maxval = 60 * HZ, 2907 .to_retries = 2, 2908 }; 2909 2910 /** 2911 * xs_setup_tcp - Set up transport to use a TCP socket 2912 * @args: rpc transport creation arguments 2913 * 2914 */ 2915 static struct rpc_xprt *xs_setup_tcp(struct xprt_create *args) 2916 { 2917 struct sockaddr *addr = args->dstaddr; 2918 struct rpc_xprt *xprt; 2919 struct sock_xprt *transport; 2920 struct rpc_xprt *ret; 2921 unsigned int max_slot_table_size = xprt_max_tcp_slot_table_entries; 2922 2923 if (args->flags & XPRT_CREATE_INFINITE_SLOTS) 2924 max_slot_table_size = RPC_MAX_SLOT_TABLE_LIMIT; 2925 2926 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries, 2927 max_slot_table_size); 2928 if (IS_ERR(xprt)) 2929 return xprt; 2930 transport = container_of(xprt, struct sock_xprt, xprt); 2931 2932 xprt->prot = IPPROTO_TCP; 2933 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32); 2934 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE; 2935 2936 xprt->bind_timeout = XS_BIND_TO; 2937 xprt->reestablish_timeout = XS_TCP_INIT_REEST_TO; 2938 xprt->idle_timeout = XS_IDLE_DISC_TO; 2939 2940 xprt->ops = &xs_tcp_ops; 2941 xprt->timeout = &xs_tcp_default_timeout; 2942 2943 xprt->max_reconnect_timeout = xprt->timeout->to_maxval; 2944 xprt->connect_timeout = xprt->timeout->to_initval * 2945 (xprt->timeout->to_retries + 1); 2946 2947 INIT_WORK(&transport->recv_worker, xs_stream_data_receive_workfn); 2948 INIT_DELAYED_WORK(&transport->connect_worker, xs_tcp_setup_socket); 2949 2950 switch (addr->sa_family) { 2951 case AF_INET: 2952 if (((struct sockaddr_in *)addr)->sin_port != htons(0)) 2953 xprt_set_bound(xprt); 2954 2955 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP); 2956 break; 2957 case AF_INET6: 2958 if (((struct sockaddr_in6 *)addr)->sin6_port != htons(0)) 2959 xprt_set_bound(xprt); 2960 2961 xs_format_peer_addresses(xprt, "tcp", RPCBIND_NETID_TCP6); 2962 break; 2963 default: 2964 ret = ERR_PTR(-EAFNOSUPPORT); 2965 goto out_err; 2966 } 2967 2968 if (xprt_bound(xprt)) 2969 dprintk("RPC: set up xprt to %s (port %s) via %s\n", 2970 xprt->address_strings[RPC_DISPLAY_ADDR], 2971 xprt->address_strings[RPC_DISPLAY_PORT], 2972 xprt->address_strings[RPC_DISPLAY_PROTO]); 2973 else 2974 dprintk("RPC: set up xprt to %s (autobind) via %s\n", 2975 xprt->address_strings[RPC_DISPLAY_ADDR], 2976 xprt->address_strings[RPC_DISPLAY_PROTO]); 2977 2978 if (try_module_get(THIS_MODULE)) 2979 return xprt; 2980 ret = ERR_PTR(-EINVAL); 2981 out_err: 2982 xs_xprt_free(xprt); 2983 return ret; 2984 } 2985 2986 /** 2987 * xs_setup_bc_tcp - Set up transport to use a TCP backchannel socket 2988 * @args: rpc transport creation arguments 2989 * 2990 */ 2991 static struct rpc_xprt *xs_setup_bc_tcp(struct xprt_create *args) 2992 { 2993 struct sockaddr *addr = args->dstaddr; 2994 struct rpc_xprt *xprt; 2995 struct sock_xprt *transport; 2996 struct svc_sock *bc_sock; 2997 struct rpc_xprt *ret; 2998 2999 xprt = xs_setup_xprt(args, xprt_tcp_slot_table_entries, 3000 xprt_tcp_slot_table_entries); 3001 if (IS_ERR(xprt)) 3002 return xprt; 3003 transport = container_of(xprt, struct sock_xprt, xprt); 3004 3005 xprt->prot = IPPROTO_TCP; 3006 xprt->tsh_size = sizeof(rpc_fraghdr) / sizeof(u32); 3007 xprt->max_payload = RPC_MAX_FRAGMENT_SIZE; 3008 xprt->timeout = &xs_tcp_default_timeout; 3009 3010 /* backchannel */ 3011 xprt_set_bound(xprt); 3012 xprt->bind_timeout = 0; 3013 xprt->reestablish_timeout = 0; 3014 xprt->idle_timeout = 0; 3015 3016 xprt->ops = &bc_tcp_ops; 3017 3018 switch (addr->sa_family) { 3019 case AF_INET: 3020 xs_format_peer_addresses(xprt, "tcp", 3021 RPCBIND_NETID_TCP); 3022 break; 3023 case AF_INET6: 3024 xs_format_peer_addresses(xprt, "tcp", 3025 RPCBIND_NETID_TCP6); 3026 break; 3027 default: 3028 ret = ERR_PTR(-EAFNOSUPPORT); 3029 goto out_err; 3030 } 3031 3032 dprintk("RPC: set up xprt to %s (port %s) via %s\n", 3033 xprt->address_strings[RPC_DISPLAY_ADDR], 3034 xprt->address_strings[RPC_DISPLAY_PORT], 3035 xprt->address_strings[RPC_DISPLAY_PROTO]); 3036 3037 /* 3038 * Once we've associated a backchannel xprt with a connection, 3039 * we want to keep it around as long as the connection lasts, 3040 * in case we need to start using it for a backchannel again; 3041 * this reference won't be dropped until bc_xprt is destroyed. 3042 */ 3043 xprt_get(xprt); 3044 args->bc_xprt->xpt_bc_xprt = xprt; 3045 xprt->bc_xprt = args->bc_xprt; 3046 bc_sock = container_of(args->bc_xprt, struct svc_sock, sk_xprt); 3047 transport->sock = bc_sock->sk_sock; 3048 transport->inet = bc_sock->sk_sk; 3049 3050 /* 3051 * Since we don't want connections for the backchannel, we set 3052 * the xprt status to connected 3053 */ 3054 xprt_set_connected(xprt); 3055 3056 if (try_module_get(THIS_MODULE)) 3057 return xprt; 3058 3059 args->bc_xprt->xpt_bc_xprt = NULL; 3060 args->bc_xprt->xpt_bc_xps = NULL; 3061 xprt_put(xprt); 3062 ret = ERR_PTR(-EINVAL); 3063 out_err: 3064 xs_xprt_free(xprt); 3065 return ret; 3066 } 3067 3068 static struct xprt_class xs_local_transport = { 3069 .list = LIST_HEAD_INIT(xs_local_transport.list), 3070 .name = "named UNIX socket", 3071 .owner = THIS_MODULE, 3072 .ident = XPRT_TRANSPORT_LOCAL, 3073 .setup = xs_setup_local, 3074 }; 3075 3076 static struct xprt_class xs_udp_transport = { 3077 .list = LIST_HEAD_INIT(xs_udp_transport.list), 3078 .name = "udp", 3079 .owner = THIS_MODULE, 3080 .ident = XPRT_TRANSPORT_UDP, 3081 .setup = xs_setup_udp, 3082 }; 3083 3084 static struct xprt_class xs_tcp_transport = { 3085 .list = LIST_HEAD_INIT(xs_tcp_transport.list), 3086 .name = "tcp", 3087 .owner = THIS_MODULE, 3088 .ident = XPRT_TRANSPORT_TCP, 3089 .setup = xs_setup_tcp, 3090 }; 3091 3092 static struct xprt_class xs_bc_tcp_transport = { 3093 .list = LIST_HEAD_INIT(xs_bc_tcp_transport.list), 3094 .name = "tcp NFSv4.1 backchannel", 3095 .owner = THIS_MODULE, 3096 .ident = XPRT_TRANSPORT_BC_TCP, 3097 .setup = xs_setup_bc_tcp, 3098 }; 3099 3100 /** 3101 * init_socket_xprt - set up xprtsock's sysctls, register with RPC client 3102 * 3103 */ 3104 int init_socket_xprt(void) 3105 { 3106 if (!sunrpc_table_header) 3107 sunrpc_table_header = register_sysctl_table(sunrpc_table); 3108 3109 xprt_register_transport(&xs_local_transport); 3110 xprt_register_transport(&xs_udp_transport); 3111 xprt_register_transport(&xs_tcp_transport); 3112 xprt_register_transport(&xs_bc_tcp_transport); 3113 3114 return 0; 3115 } 3116 3117 /** 3118 * cleanup_socket_xprt - remove xprtsock's sysctls, unregister 3119 * 3120 */ 3121 void cleanup_socket_xprt(void) 3122 { 3123 if (sunrpc_table_header) { 3124 unregister_sysctl_table(sunrpc_table_header); 3125 sunrpc_table_header = NULL; 3126 } 3127 3128 xprt_unregister_transport(&xs_local_transport); 3129 xprt_unregister_transport(&xs_udp_transport); 3130 xprt_unregister_transport(&xs_tcp_transport); 3131 xprt_unregister_transport(&xs_bc_tcp_transport); 3132 } 3133 3134 static int param_set_uint_minmax(const char *val, 3135 const struct kernel_param *kp, 3136 unsigned int min, unsigned int max) 3137 { 3138 unsigned int num; 3139 int ret; 3140 3141 if (!val) 3142 return -EINVAL; 3143 ret = kstrtouint(val, 0, &num); 3144 if (ret) 3145 return ret; 3146 if (num < min || num > max) 3147 return -EINVAL; 3148 *((unsigned int *)kp->arg) = num; 3149 return 0; 3150 } 3151 3152 static int param_set_portnr(const char *val, const struct kernel_param *kp) 3153 { 3154 return param_set_uint_minmax(val, kp, 3155 RPC_MIN_RESVPORT, 3156 RPC_MAX_RESVPORT); 3157 } 3158 3159 static const struct kernel_param_ops param_ops_portnr = { 3160 .set = param_set_portnr, 3161 .get = param_get_uint, 3162 }; 3163 3164 #define param_check_portnr(name, p) \ 3165 __param_check(name, p, unsigned int); 3166 3167 module_param_named(min_resvport, xprt_min_resvport, portnr, 0644); 3168 module_param_named(max_resvport, xprt_max_resvport, portnr, 0644); 3169 3170 static int param_set_slot_table_size(const char *val, 3171 const struct kernel_param *kp) 3172 { 3173 return param_set_uint_minmax(val, kp, 3174 RPC_MIN_SLOT_TABLE, 3175 RPC_MAX_SLOT_TABLE); 3176 } 3177 3178 static const struct kernel_param_ops param_ops_slot_table_size = { 3179 .set = param_set_slot_table_size, 3180 .get = param_get_uint, 3181 }; 3182 3183 #define param_check_slot_table_size(name, p) \ 3184 __param_check(name, p, unsigned int); 3185 3186 static int param_set_max_slot_table_size(const char *val, 3187 const struct kernel_param *kp) 3188 { 3189 return param_set_uint_minmax(val, kp, 3190 RPC_MIN_SLOT_TABLE, 3191 RPC_MAX_SLOT_TABLE_LIMIT); 3192 } 3193 3194 static const struct kernel_param_ops param_ops_max_slot_table_size = { 3195 .set = param_set_max_slot_table_size, 3196 .get = param_get_uint, 3197 }; 3198 3199 #define param_check_max_slot_table_size(name, p) \ 3200 __param_check(name, p, unsigned int); 3201 3202 module_param_named(tcp_slot_table_entries, xprt_tcp_slot_table_entries, 3203 slot_table_size, 0644); 3204 module_param_named(tcp_max_slot_table_entries, xprt_max_tcp_slot_table_entries, 3205 max_slot_table_size, 0644); 3206 module_param_named(udp_slot_table_entries, xprt_udp_slot_table_entries, 3207 slot_table_size, 0644); 3208