1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * linux/net/sunrpc/svc.c 4 * 5 * High-level RPC service routines 6 * 7 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de> 8 * 9 * Multiple threads pools and NUMAisation 10 * Copyright (c) 2006 Silicon Graphics, Inc. 11 * by Greg Banks <gnb@melbourne.sgi.com> 12 */ 13 14 #include <linux/linkage.h> 15 #include <linux/sched/signal.h> 16 #include <linux/errno.h> 17 #include <linux/net.h> 18 #include <linux/in.h> 19 #include <linux/mm.h> 20 #include <linux/interrupt.h> 21 #include <linux/module.h> 22 #include <linux/kthread.h> 23 #include <linux/slab.h> 24 25 #include <linux/sunrpc/types.h> 26 #include <linux/sunrpc/xdr.h> 27 #include <linux/sunrpc/stats.h> 28 #include <linux/sunrpc/svcsock.h> 29 #include <linux/sunrpc/clnt.h> 30 #include <linux/sunrpc/bc_xprt.h> 31 32 #include <trace/events/sunrpc.h> 33 34 #include "fail.h" 35 #include "sunrpc.h" 36 37 #define RPCDBG_FACILITY RPCDBG_SVCDSP 38 39 static void svc_unregister(const struct svc_serv *serv, struct net *net); 40 41 #define SVC_POOL_DEFAULT SVC_POOL_GLOBAL 42 43 /* 44 * Mode for mapping cpus to pools. 45 */ 46 enum { 47 SVC_POOL_AUTO = -1, /* choose one of the others */ 48 SVC_POOL_GLOBAL, /* no mapping, just a single global pool 49 * (legacy & UP mode) */ 50 SVC_POOL_PERCPU, /* one pool per cpu */ 51 SVC_POOL_PERNODE /* one pool per numa node */ 52 }; 53 54 /* 55 * Structure for mapping cpus to pools and vice versa. 56 * Setup once during sunrpc initialisation. 57 */ 58 59 struct svc_pool_map { 60 int count; /* How many svc_servs use us */ 61 int mode; /* Note: int not enum to avoid 62 * warnings about "enumeration value 63 * not handled in switch" */ 64 unsigned int npools; 65 unsigned int *pool_to; /* maps pool id to cpu or node */ 66 unsigned int *to_pool; /* maps cpu or node to pool id */ 67 }; 68 69 static struct svc_pool_map svc_pool_map = { 70 .mode = SVC_POOL_DEFAULT 71 }; 72 73 static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */ 74 75 static int 76 __param_set_pool_mode(const char *val, struct svc_pool_map *m) 77 { 78 int err, mode; 79 80 mutex_lock(&svc_pool_map_mutex); 81 82 err = 0; 83 if (!strncmp(val, "auto", 4)) 84 mode = SVC_POOL_AUTO; 85 else if (!strncmp(val, "global", 6)) 86 mode = SVC_POOL_GLOBAL; 87 else if (!strncmp(val, "percpu", 6)) 88 mode = SVC_POOL_PERCPU; 89 else if (!strncmp(val, "pernode", 7)) 90 mode = SVC_POOL_PERNODE; 91 else 92 err = -EINVAL; 93 94 if (err) 95 goto out; 96 97 if (m->count == 0) 98 m->mode = mode; 99 else if (mode != m->mode) 100 err = -EBUSY; 101 out: 102 mutex_unlock(&svc_pool_map_mutex); 103 return err; 104 } 105 106 static int 107 param_set_pool_mode(const char *val, const struct kernel_param *kp) 108 { 109 struct svc_pool_map *m = kp->arg; 110 111 return __param_set_pool_mode(val, m); 112 } 113 114 int sunrpc_set_pool_mode(const char *val) 115 { 116 return __param_set_pool_mode(val, &svc_pool_map); 117 } 118 EXPORT_SYMBOL(sunrpc_set_pool_mode); 119 120 /** 121 * sunrpc_get_pool_mode - get the current pool_mode for the host 122 * @buf: where to write the current pool_mode 123 * @size: size of @buf 124 * 125 * Grab the current pool_mode from the svc_pool_map and write 126 * the resulting string to @buf. Returns the number of characters 127 * written to @buf (a'la snprintf()). 128 */ 129 int 130 sunrpc_get_pool_mode(char *buf, size_t size) 131 { 132 struct svc_pool_map *m = &svc_pool_map; 133 134 switch (m->mode) 135 { 136 case SVC_POOL_AUTO: 137 return snprintf(buf, size, "auto"); 138 case SVC_POOL_GLOBAL: 139 return snprintf(buf, size, "global"); 140 case SVC_POOL_PERCPU: 141 return snprintf(buf, size, "percpu"); 142 case SVC_POOL_PERNODE: 143 return snprintf(buf, size, "pernode"); 144 default: 145 return snprintf(buf, size, "%d", m->mode); 146 } 147 } 148 EXPORT_SYMBOL(sunrpc_get_pool_mode); 149 150 static int 151 param_get_pool_mode(char *buf, const struct kernel_param *kp) 152 { 153 char str[16]; 154 int len; 155 156 len = sunrpc_get_pool_mode(str, ARRAY_SIZE(str)); 157 158 /* Ensure we have room for newline and NUL */ 159 len = min_t(int, len, ARRAY_SIZE(str) - 2); 160 161 /* tack on the newline */ 162 str[len] = '\n'; 163 str[len + 1] = '\0'; 164 165 return sysfs_emit(buf, "%s", str); 166 } 167 168 module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode, 169 &svc_pool_map, 0644); 170 171 /* 172 * Detect best pool mapping mode heuristically, 173 * according to the machine's topology. 174 */ 175 static int 176 svc_pool_map_choose_mode(void) 177 { 178 unsigned int node; 179 180 if (nr_online_nodes > 1) { 181 /* 182 * Actually have multiple NUMA nodes, 183 * so split pools on NUMA node boundaries 184 */ 185 return SVC_POOL_PERNODE; 186 } 187 188 node = first_online_node; 189 if (nr_cpus_node(node) > 2) { 190 /* 191 * Non-trivial SMP, or CONFIG_NUMA on 192 * non-NUMA hardware, e.g. with a generic 193 * x86_64 kernel on Xeons. In this case we 194 * want to divide the pools on cpu boundaries. 195 */ 196 return SVC_POOL_PERCPU; 197 } 198 199 /* default: one global pool */ 200 return SVC_POOL_GLOBAL; 201 } 202 203 /* 204 * Allocate the to_pool[] and pool_to[] arrays. 205 * Returns 0 on success or an errno. 206 */ 207 static int 208 svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools) 209 { 210 m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL); 211 if (!m->to_pool) 212 goto fail; 213 m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL); 214 if (!m->pool_to) 215 goto fail_free; 216 217 return 0; 218 219 fail_free: 220 kfree(m->to_pool); 221 m->to_pool = NULL; 222 fail: 223 return -ENOMEM; 224 } 225 226 /* 227 * Initialise the pool map for SVC_POOL_PERCPU mode. 228 * Returns number of pools or <0 on error. 229 */ 230 static int 231 svc_pool_map_init_percpu(struct svc_pool_map *m) 232 { 233 unsigned int maxpools = nr_cpu_ids; 234 unsigned int pidx = 0; 235 unsigned int cpu; 236 int err; 237 238 err = svc_pool_map_alloc_arrays(m, maxpools); 239 if (err) 240 return err; 241 242 for_each_online_cpu(cpu) { 243 BUG_ON(pidx >= maxpools); 244 m->to_pool[cpu] = pidx; 245 m->pool_to[pidx] = cpu; 246 pidx++; 247 } 248 /* cpus brought online later all get mapped to pool0, sorry */ 249 250 return pidx; 251 }; 252 253 254 /* 255 * Initialise the pool map for SVC_POOL_PERNODE mode. 256 * Returns number of pools or <0 on error. 257 */ 258 static int 259 svc_pool_map_init_pernode(struct svc_pool_map *m) 260 { 261 unsigned int maxpools = nr_node_ids; 262 unsigned int pidx = 0; 263 unsigned int node; 264 int err; 265 266 err = svc_pool_map_alloc_arrays(m, maxpools); 267 if (err) 268 return err; 269 270 for_each_node_with_cpus(node) { 271 /* some architectures (e.g. SN2) have cpuless nodes */ 272 BUG_ON(pidx > maxpools); 273 m->to_pool[node] = pidx; 274 m->pool_to[pidx] = node; 275 pidx++; 276 } 277 /* nodes brought online later all get mapped to pool0, sorry */ 278 279 return pidx; 280 } 281 282 283 /* 284 * Add a reference to the global map of cpus to pools (and 285 * vice versa) if pools are in use. 286 * Initialise the map if we're the first user. 287 * Returns the number of pools. If this is '1', no reference 288 * was taken. 289 */ 290 static unsigned int 291 svc_pool_map_get(void) 292 { 293 struct svc_pool_map *m = &svc_pool_map; 294 int npools = -1; 295 296 mutex_lock(&svc_pool_map_mutex); 297 if (m->count++) { 298 mutex_unlock(&svc_pool_map_mutex); 299 return m->npools; 300 } 301 302 if (m->mode == SVC_POOL_AUTO) 303 m->mode = svc_pool_map_choose_mode(); 304 305 switch (m->mode) { 306 case SVC_POOL_PERCPU: 307 npools = svc_pool_map_init_percpu(m); 308 break; 309 case SVC_POOL_PERNODE: 310 npools = svc_pool_map_init_pernode(m); 311 break; 312 } 313 314 if (npools <= 0) { 315 /* default, or memory allocation failure */ 316 npools = 1; 317 m->mode = SVC_POOL_GLOBAL; 318 } 319 m->npools = npools; 320 mutex_unlock(&svc_pool_map_mutex); 321 return npools; 322 } 323 324 /* 325 * Drop a reference to the global map of cpus to pools. 326 * When the last reference is dropped, the map data is 327 * freed; this allows the sysadmin to change the pool. 328 */ 329 static void 330 svc_pool_map_put(void) 331 { 332 struct svc_pool_map *m = &svc_pool_map; 333 334 mutex_lock(&svc_pool_map_mutex); 335 if (!--m->count) { 336 kfree(m->to_pool); 337 m->to_pool = NULL; 338 kfree(m->pool_to); 339 m->pool_to = NULL; 340 m->npools = 0; 341 } 342 mutex_unlock(&svc_pool_map_mutex); 343 } 344 345 static int svc_pool_map_get_node(unsigned int pidx) 346 { 347 const struct svc_pool_map *m = &svc_pool_map; 348 349 if (m->count) { 350 if (m->mode == SVC_POOL_PERCPU) 351 return cpu_to_node(m->pool_to[pidx]); 352 if (m->mode == SVC_POOL_PERNODE) 353 return m->pool_to[pidx]; 354 } 355 return numa_mem_id(); 356 } 357 /* 358 * Set the given thread's cpus_allowed mask so that it 359 * will only run on cpus in the given pool. 360 */ 361 static inline void 362 svc_pool_map_set_cpumask(struct task_struct *task, unsigned int pidx) 363 { 364 struct svc_pool_map *m = &svc_pool_map; 365 unsigned int node = m->pool_to[pidx]; 366 367 /* 368 * The caller checks for sv_nrpools > 1, which 369 * implies that we've been initialized. 370 */ 371 WARN_ON_ONCE(m->count == 0); 372 if (m->count == 0) 373 return; 374 375 switch (m->mode) { 376 case SVC_POOL_PERCPU: 377 { 378 set_cpus_allowed_ptr(task, cpumask_of(node)); 379 break; 380 } 381 case SVC_POOL_PERNODE: 382 { 383 set_cpus_allowed_ptr(task, cpumask_of_node(node)); 384 break; 385 } 386 } 387 } 388 389 /** 390 * svc_pool_for_cpu - Select pool to run a thread on this cpu 391 * @serv: An RPC service 392 * 393 * Use the active CPU and the svc_pool_map's mode setting to 394 * select the svc thread pool to use. Once initialized, the 395 * svc_pool_map does not change. 396 * 397 * Return value: 398 * A pointer to an svc_pool 399 */ 400 struct svc_pool *svc_pool_for_cpu(struct svc_serv *serv) 401 { 402 struct svc_pool_map *m = &svc_pool_map; 403 int cpu = raw_smp_processor_id(); 404 unsigned int pidx = 0; 405 406 if (serv->sv_nrpools <= 1) 407 return serv->sv_pools; 408 409 switch (m->mode) { 410 case SVC_POOL_PERCPU: 411 pidx = m->to_pool[cpu]; 412 break; 413 case SVC_POOL_PERNODE: 414 pidx = m->to_pool[cpu_to_node(cpu)]; 415 break; 416 } 417 418 return &serv->sv_pools[pidx % serv->sv_nrpools]; 419 } 420 421 static int svc_rpcb_setup(struct svc_serv *serv, struct net *net) 422 { 423 int err; 424 425 err = rpcb_create_local(net); 426 if (err) 427 return err; 428 429 /* Remove any stale portmap registrations */ 430 svc_unregister(serv, net); 431 return 0; 432 } 433 434 void svc_rpcb_cleanup(struct svc_serv *serv, struct net *net) 435 { 436 svc_unregister(serv, net); 437 rpcb_put_local(net); 438 } 439 440 static int svc_uses_rpcbind(struct svc_serv *serv) 441 { 442 unsigned int p, i; 443 444 for (p = 0; p < serv->sv_nprogs; p++) { 445 struct svc_program *progp = &serv->sv_programs[p]; 446 447 for (i = 0; i < progp->pg_nvers; i++) { 448 if (progp->pg_vers[i] == NULL) 449 continue; 450 if (!progp->pg_vers[i]->vs_hidden) 451 return 1; 452 } 453 } 454 455 return 0; 456 } 457 458 int svc_bind(struct svc_serv *serv, struct net *net) 459 { 460 if (!svc_uses_rpcbind(serv)) 461 return 0; 462 return svc_rpcb_setup(serv, net); 463 } 464 EXPORT_SYMBOL_GPL(svc_bind); 465 466 #if defined(CONFIG_SUNRPC_BACKCHANNEL) 467 static void 468 __svc_init_bc(struct svc_serv *serv) 469 { 470 lwq_init(&serv->sv_cb_list); 471 } 472 #else 473 static void 474 __svc_init_bc(struct svc_serv *serv) 475 { 476 } 477 #endif 478 479 /* 480 * Create an RPC service 481 */ 482 static struct svc_serv * 483 __svc_create(struct svc_program *prog, int nprogs, struct svc_stat *stats, 484 unsigned int bufsize, int npools, int (*threadfn)(void *data)) 485 { 486 struct svc_serv *serv; 487 unsigned int vers; 488 unsigned int xdrsize; 489 unsigned int i; 490 491 if (!(serv = kzalloc_obj(*serv))) 492 return NULL; 493 serv->sv_name = prog->pg_name; 494 serv->sv_programs = prog; 495 serv->sv_nprogs = nprogs; 496 serv->sv_stats = stats; 497 if (bufsize > RPCSVC_MAXPAYLOAD) 498 bufsize = RPCSVC_MAXPAYLOAD; 499 serv->sv_max_payload = bufsize? bufsize : 4096; 500 serv->sv_max_mesg = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE); 501 serv->sv_threadfn = threadfn; 502 xdrsize = 0; 503 for (i = 0; i < nprogs; i++) { 504 struct svc_program *progp = &prog[i]; 505 506 progp->pg_lovers = progp->pg_nvers-1; 507 for (vers = 0; vers < progp->pg_nvers ; vers++) 508 if (progp->pg_vers[vers]) { 509 progp->pg_hivers = vers; 510 if (progp->pg_lovers > vers) 511 progp->pg_lovers = vers; 512 if (progp->pg_vers[vers]->vs_xdrsize > xdrsize) 513 xdrsize = progp->pg_vers[vers]->vs_xdrsize; 514 } 515 } 516 serv->sv_xdrsize = xdrsize; 517 INIT_LIST_HEAD(&serv->sv_tempsocks); 518 INIT_LIST_HEAD(&serv->sv_permsocks); 519 timer_setup(&serv->sv_temptimer, NULL, 0); 520 spin_lock_init(&serv->sv_lock); 521 522 __svc_init_bc(serv); 523 524 serv->sv_nrpools = npools; 525 serv->sv_pools = 526 kzalloc_objs(struct svc_pool, serv->sv_nrpools); 527 if (!serv->sv_pools) { 528 kfree(serv); 529 return NULL; 530 } 531 532 for (i = 0; i < serv->sv_nrpools; i++) { 533 struct svc_pool *pool = &serv->sv_pools[i]; 534 535 dprintk("svc: initialising pool %u for %s\n", 536 i, serv->sv_name); 537 538 pool->sp_id = i; 539 lwq_init(&pool->sp_xprts); 540 INIT_LIST_HEAD(&pool->sp_all_threads); 541 init_llist_head(&pool->sp_idle_threads); 542 543 percpu_counter_init(&pool->sp_messages_arrived, 0, GFP_KERNEL); 544 percpu_counter_init(&pool->sp_sockets_queued, 0, GFP_KERNEL); 545 percpu_counter_init(&pool->sp_threads_woken, 0, GFP_KERNEL); 546 } 547 548 return serv; 549 } 550 551 /** 552 * svc_create - Create an RPC service 553 * @prog: the RPC program the new service will handle 554 * @bufsize: maximum message size for @prog 555 * @threadfn: a function to service RPC requests for @prog 556 * 557 * Returns an instantiated struct svc_serv object or NULL. 558 */ 559 struct svc_serv *svc_create(struct svc_program *prog, unsigned int bufsize, 560 int (*threadfn)(void *data)) 561 { 562 return __svc_create(prog, 1, NULL, bufsize, 1, threadfn); 563 } 564 EXPORT_SYMBOL_GPL(svc_create); 565 566 /** 567 * svc_create_pooled - Create an RPC service with pooled threads 568 * @prog: Array of RPC programs the new service will handle 569 * @nprogs: Number of programs in the array 570 * @stats: the stats struct if desired 571 * @bufsize: maximum message size for @prog 572 * @threadfn: a function to service RPC requests for @prog 573 * 574 * Returns an instantiated struct svc_serv object or NULL. 575 */ 576 struct svc_serv *svc_create_pooled(struct svc_program *prog, 577 unsigned int nprogs, 578 struct svc_stat *stats, 579 unsigned int bufsize, 580 int (*threadfn)(void *data)) 581 { 582 struct svc_serv *serv; 583 unsigned int npools = svc_pool_map_get(); 584 585 serv = __svc_create(prog, nprogs, stats, bufsize, npools, threadfn); 586 if (!serv) 587 goto out_err; 588 serv->sv_is_pooled = true; 589 return serv; 590 out_err: 591 svc_pool_map_put(); 592 return NULL; 593 } 594 EXPORT_SYMBOL_GPL(svc_create_pooled); 595 596 /* 597 * Destroy an RPC service. Should be called with appropriate locking to 598 * protect sv_permsocks and sv_tempsocks. 599 */ 600 void 601 svc_destroy(struct svc_serv **servp) 602 { 603 struct svc_serv *serv = *servp; 604 unsigned int i; 605 606 *servp = NULL; 607 608 dprintk("svc: svc_destroy(%s)\n", serv->sv_programs->pg_name); 609 timer_shutdown_sync(&serv->sv_temptimer); 610 611 /* 612 * Remaining transports at this point are not expected. 613 */ 614 WARN_ONCE(!list_empty(&serv->sv_permsocks), 615 "SVC: permsocks remain for %s\n", serv->sv_programs->pg_name); 616 WARN_ONCE(!list_empty(&serv->sv_tempsocks), 617 "SVC: tempsocks remain for %s\n", serv->sv_programs->pg_name); 618 619 cache_clean_deferred(serv); 620 621 if (serv->sv_is_pooled) 622 svc_pool_map_put(); 623 624 for (i = 0; i < serv->sv_nrpools; i++) { 625 struct svc_pool *pool = &serv->sv_pools[i]; 626 627 percpu_counter_destroy(&pool->sp_messages_arrived); 628 percpu_counter_destroy(&pool->sp_sockets_queued); 629 percpu_counter_destroy(&pool->sp_threads_woken); 630 } 631 kfree(serv->sv_pools); 632 kfree(serv); 633 } 634 EXPORT_SYMBOL_GPL(svc_destroy); 635 636 static bool 637 svc_init_buffer(struct svc_rqst *rqstp, const struct svc_serv *serv, int node) 638 { 639 rqstp->rq_maxpages = svc_serv_maxpages(serv); 640 641 /* +1 for a NULL sentinel readable by nfsd_splice_actor() */ 642 rqstp->rq_pages = kcalloc_node(rqstp->rq_maxpages + 1, 643 sizeof(struct page *), 644 GFP_KERNEL, node); 645 if (!rqstp->rq_pages) 646 return false; 647 648 /* +1 for a NULL sentinel at rq_page_end (see svc_rqst_replace_page) */ 649 rqstp->rq_respages = kcalloc_node(rqstp->rq_maxpages + 1, 650 sizeof(struct page *), 651 GFP_KERNEL, node); 652 if (!rqstp->rq_respages) { 653 kfree(rqstp->rq_pages); 654 rqstp->rq_pages = NULL; 655 return false; 656 } 657 658 rqstp->rq_pages_nfree = rqstp->rq_maxpages; 659 rqstp->rq_next_page = rqstp->rq_respages + rqstp->rq_maxpages; 660 return true; 661 } 662 663 /* 664 * Release an RPC server buffer 665 */ 666 static void 667 svc_release_buffer(struct svc_rqst *rqstp) 668 { 669 unsigned long i; 670 671 if (rqstp->rq_pages) { 672 for (i = 0; i < rqstp->rq_maxpages; i++) 673 if (rqstp->rq_pages[i]) 674 put_page(rqstp->rq_pages[i]); 675 kfree(rqstp->rq_pages); 676 } 677 678 if (rqstp->rq_respages) { 679 for (i = 0; i < rqstp->rq_maxpages; i++) 680 if (rqstp->rq_respages[i]) 681 put_page(rqstp->rq_respages[i]); 682 kfree(rqstp->rq_respages); 683 } 684 } 685 686 static void 687 svc_rqst_free(struct svc_rqst *rqstp) 688 { 689 folio_batch_release(&rqstp->rq_fbatch); 690 kfree(rqstp->rq_bvec); 691 svc_release_buffer(rqstp); 692 if (rqstp->rq_scratch_folio) 693 folio_put(rqstp->rq_scratch_folio); 694 kfree(rqstp->rq_resp); 695 kfree(rqstp->rq_argp); 696 kfree(rqstp->rq_auth_data); 697 kfree_rcu(rqstp, rq_rcu_head); 698 } 699 700 static struct svc_rqst * 701 svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool, int node) 702 { 703 struct svc_rqst *rqstp; 704 705 rqstp = kzalloc_node(sizeof(*rqstp), GFP_KERNEL, node); 706 if (!rqstp) 707 return rqstp; 708 709 folio_batch_init(&rqstp->rq_fbatch); 710 711 rqstp->rq_server = serv; 712 rqstp->rq_pool = pool; 713 714 rqstp->rq_scratch_folio = __folio_alloc_node(GFP_KERNEL, 0, node); 715 if (!rqstp->rq_scratch_folio) 716 goto out_enomem; 717 718 rqstp->rq_argp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node); 719 if (!rqstp->rq_argp) 720 goto out_enomem; 721 722 rqstp->rq_resp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node); 723 if (!rqstp->rq_resp) 724 goto out_enomem; 725 726 if (!svc_init_buffer(rqstp, serv, node)) 727 goto out_enomem; 728 729 rqstp->rq_bvec = kcalloc_node(rqstp->rq_maxpages, 730 sizeof(struct bio_vec), 731 GFP_KERNEL, node); 732 if (!rqstp->rq_bvec) 733 goto out_enomem; 734 735 rqstp->rq_err = -EAGAIN; /* No error yet */ 736 737 serv->sv_nrthreads += 1; 738 pool->sp_nrthreads += 1; 739 740 /* Protected by whatever lock the service uses when calling 741 * svc_set_num_threads() 742 */ 743 list_add_rcu(&rqstp->rq_all, &pool->sp_all_threads); 744 745 return rqstp; 746 747 out_enomem: 748 svc_rqst_free(rqstp); 749 return NULL; 750 } 751 752 /** 753 * svc_pool_wake_idle_thread - Awaken an idle thread in @pool 754 * @pool: service thread pool 755 * 756 * Can be called from soft IRQ or process context. Finding an idle 757 * service thread and marking it BUSY is atomic with respect to 758 * other calls to svc_pool_wake_idle_thread(). 759 * 760 */ 761 void svc_pool_wake_idle_thread(struct svc_pool *pool) 762 { 763 struct svc_rqst *rqstp; 764 struct llist_node *ln; 765 766 rcu_read_lock(); 767 ln = READ_ONCE(pool->sp_idle_threads.first); 768 if (ln) { 769 rqstp = llist_entry(ln, struct svc_rqst, rq_idle); 770 WRITE_ONCE(rqstp->rq_qtime, ktime_get()); 771 if (!task_is_running(rqstp->rq_task)) { 772 wake_up_process(rqstp->rq_task); 773 trace_svc_pool_thread_wake(pool, rqstp->rq_task->pid); 774 percpu_counter_inc(&pool->sp_threads_woken); 775 } else { 776 trace_svc_pool_thread_running(pool, rqstp->rq_task->pid); 777 } 778 rcu_read_unlock(); 779 return; 780 } 781 rcu_read_unlock(); 782 trace_svc_pool_thread_noidle(pool, 0); 783 } 784 EXPORT_SYMBOL_GPL(svc_pool_wake_idle_thread); 785 786 /** 787 * svc_new_thread - spawn a new thread in the given pool 788 * @serv: the serv to which the pool belongs 789 * @pool: pool in which thread should be spawned 790 * 791 * Create a new thread inside @pool, which is a part of @serv. 792 * Caller must hold the service mutex. 793 * 794 * Returns 0 on success, or -errno on failure. 795 */ 796 int svc_new_thread(struct svc_serv *serv, struct svc_pool *pool) 797 { 798 struct svc_rqst *rqstp; 799 struct task_struct *task; 800 int node; 801 int err = 0; 802 803 node = svc_pool_map_get_node(pool->sp_id); 804 805 rqstp = svc_prepare_thread(serv, pool, node); 806 if (!rqstp) 807 return -ENOMEM; 808 task = kthread_create_on_node(serv->sv_threadfn, rqstp, 809 node, "%s", serv->sv_name); 810 if (IS_ERR(task)) { 811 err = PTR_ERR(task); 812 goto out; 813 } 814 815 rqstp->rq_task = task; 816 if (serv->sv_nrpools > 1) 817 svc_pool_map_set_cpumask(task, pool->sp_id); 818 819 svc_sock_update_bufs(serv); 820 wake_up_process(task); 821 822 /* Wait for the thread to signal initialization status */ 823 wait_var_event(&rqstp->rq_err, rqstp->rq_err != -EAGAIN); 824 err = rqstp->rq_err; 825 out: 826 if (err) 827 svc_exit_thread(rqstp); 828 return err; 829 } 830 EXPORT_SYMBOL_GPL(svc_new_thread); 831 832 static int 833 svc_start_kthreads(struct svc_serv *serv, struct svc_pool *pool, int nrservs) 834 { 835 int err = 0; 836 837 while (!err && nrservs--) 838 err = svc_new_thread(serv, pool); 839 840 return err; 841 } 842 843 static int 844 svc_stop_kthreads(struct svc_serv *serv, struct svc_pool *pool, int nrservs) 845 { 846 do { 847 set_bit(SP_VICTIM_REMAINS, &pool->sp_flags); 848 set_bit(SP_NEED_VICTIM, &pool->sp_flags); 849 svc_pool_wake_idle_thread(pool); 850 wait_on_bit(&pool->sp_flags, SP_VICTIM_REMAINS, TASK_IDLE); 851 nrservs++; 852 } while (nrservs < 0); 853 return 0; 854 } 855 856 /** 857 * svc_set_pool_threads - adjust number of threads per pool 858 * @serv: RPC service to adjust 859 * @pool: Specific pool from which to choose threads 860 * @min_threads: min number of threads to run in @pool 861 * @max_threads: max number of threads in @pool (0 means kill all threads) 862 * 863 * Create or destroy threads in @pool to bring it into an acceptable range 864 * between @min_threads and @max_threads. 865 * 866 * If @min_threads is 0 or larger than @max_threads, then it is ignored and 867 * the pool will be set to run a static @max_threads number of threads. 868 * 869 * Caller must ensure mutual exclusion between this and server startup or 870 * shutdown. 871 * 872 * Returns zero on success or a negative errno if an error occurred while 873 * starting a thread. 874 */ 875 int 876 svc_set_pool_threads(struct svc_serv *serv, struct svc_pool *pool, 877 unsigned int min_threads, unsigned int max_threads) 878 { 879 int delta; 880 881 if (!pool) 882 return -EINVAL; 883 884 /* clamp min threads to the max */ 885 if (min_threads > max_threads) 886 min_threads = max_threads; 887 888 pool->sp_nrthrmin = min_threads; 889 pool->sp_nrthrmax = max_threads; 890 891 /* 892 * When min_threads is set, then only change the number of 893 * threads to bring it within an acceptable range. 894 */ 895 if (min_threads) { 896 if (pool->sp_nrthreads > max_threads) 897 delta = max_threads; 898 else if (pool->sp_nrthreads < min_threads) 899 delta = min_threads; 900 else 901 return 0; 902 } else { 903 delta = max_threads; 904 } 905 906 delta -= pool->sp_nrthreads; 907 if (delta > 0) 908 return svc_start_kthreads(serv, pool, delta); 909 if (delta < 0) 910 return svc_stop_kthreads(serv, pool, delta); 911 return 0; 912 } 913 EXPORT_SYMBOL_GPL(svc_set_pool_threads); 914 915 /** 916 * svc_set_num_threads - adjust number of threads in serv 917 * @serv: RPC service to adjust 918 * @min_threads: min number of threads to run per pool 919 * @nrservs: New number of threads for @serv (0 means kill all threads) 920 * 921 * Create or destroy threads in @serv to bring it to @nrservs. If there 922 * are multiple pools then the new threads or victims will be distributed 923 * evenly among them. 924 * 925 * Caller must ensure mutual exclusion between this and server startup or 926 * shutdown. 927 * 928 * Returns zero on success or a negative errno if an error occurred while 929 * starting a thread. On failure, some pools may have already been 930 * adjusted; the caller is responsible for recovery. 931 */ 932 int 933 svc_set_num_threads(struct svc_serv *serv, unsigned int min_threads, 934 unsigned int nrservs) 935 { 936 unsigned int base = nrservs / serv->sv_nrpools; 937 unsigned int remain = nrservs % serv->sv_nrpools; 938 int i, err = 0; 939 940 for (i = 0; i < serv->sv_nrpools; ++i) { 941 struct svc_pool *pool = &serv->sv_pools[i]; 942 int threads = base; 943 944 if (remain) { 945 ++threads; 946 --remain; 947 } 948 949 err = svc_set_pool_threads(serv, pool, min_threads, threads); 950 if (err) 951 break; 952 } 953 return err; 954 } 955 EXPORT_SYMBOL_GPL(svc_set_num_threads); 956 957 /** 958 * svc_rqst_replace_page - Replace one page in rq_respages[] 959 * @rqstp: svc_rqst with pages to replace 960 * @page: replacement page 961 * 962 * When replacing a page in rq_respages, batch the release of the 963 * replaced pages to avoid hammering the page allocator. 964 * 965 * Return values: 966 * %true: page replaced 967 * %false: array bounds checking failed 968 */ 969 bool svc_rqst_replace_page(struct svc_rqst *rqstp, struct page *page) 970 { 971 struct page **begin = rqstp->rq_respages; 972 struct page **end = rqstp->rq_page_end; 973 974 if (unlikely(rqstp->rq_next_page < begin || rqstp->rq_next_page > end)) { 975 trace_svc_replace_page_err(rqstp); 976 return false; 977 } 978 979 if (*rqstp->rq_next_page) 980 svc_rqst_page_release(rqstp, *rqstp->rq_next_page); 981 982 get_page(page); 983 *(rqstp->rq_next_page++) = page; 984 return true; 985 } 986 EXPORT_SYMBOL_GPL(svc_rqst_replace_page); 987 988 /** 989 * svc_rqst_release_pages - Release Reply buffer pages 990 * @rqstp: RPC transaction context 991 * 992 * Release response pages in the range [rq_respages, rq_next_page). 993 * NULL entries in this range are skipped, allowing transports to 994 * transfer pages to a send context before this function runs. 995 */ 996 void svc_rqst_release_pages(struct svc_rqst *rqstp) 997 { 998 struct page **pp; 999 1000 for (pp = rqstp->rq_respages; pp < rqstp->rq_next_page; pp++) { 1001 if (*pp) { 1002 if (!folio_batch_add(&rqstp->rq_fbatch, 1003 page_folio(*pp))) 1004 __folio_batch_release(&rqstp->rq_fbatch); 1005 *pp = NULL; 1006 } 1007 } 1008 if (rqstp->rq_fbatch.nr) 1009 __folio_batch_release(&rqstp->rq_fbatch); 1010 } 1011 1012 /** 1013 * svc_exit_thread - finalise the termination of a sunrpc server thread 1014 * @rqstp: the svc_rqst which represents the thread. 1015 * 1016 * When a thread started with svc_new_thread() exits it must call 1017 * svc_exit_thread() as its last act. This must be done with the 1018 * service mutex held. Normally this is held by a DIFFERENT thread, the 1019 * one that is calling svc_set_num_threads() and which will wait for 1020 * SP_VICTIM_REMAINS to be cleared before dropping the mutex. If the 1021 * thread exits for any reason other than svc_thread_should_stop() 1022 * returning %true (which indicated that svc_set_num_threads() is 1023 * waiting for it to exit), then it must take the service mutex itself, 1024 * which can only safely be done using mutex_try_lock(). 1025 */ 1026 void 1027 svc_exit_thread(struct svc_rqst *rqstp) 1028 { 1029 struct svc_serv *serv = rqstp->rq_server; 1030 struct svc_pool *pool = rqstp->rq_pool; 1031 1032 list_del_rcu(&rqstp->rq_all); 1033 1034 pool->sp_nrthreads -= 1; 1035 serv->sv_nrthreads -= 1; 1036 svc_sock_update_bufs(serv); 1037 1038 svc_rqst_free(rqstp); 1039 1040 clear_and_wake_up_bit(SP_VICTIM_REMAINS, &pool->sp_flags); 1041 } 1042 EXPORT_SYMBOL_GPL(svc_exit_thread); 1043 1044 /* 1045 * Register an "inet" protocol family netid with the local 1046 * rpcbind daemon via an rpcbind v4 SET request. 1047 * 1048 * No netconfig infrastructure is available in the kernel, so 1049 * we map IP_ protocol numbers to netids by hand. 1050 * 1051 * Returns zero on success; a negative errno value is returned 1052 * if any error occurs. 1053 */ 1054 static int __svc_rpcb_register4(struct net *net, const u32 program, 1055 const u32 version, 1056 const unsigned short protocol, 1057 const unsigned short port) 1058 { 1059 const struct sockaddr_in sin = { 1060 .sin_family = AF_INET, 1061 .sin_addr.s_addr = htonl(INADDR_ANY), 1062 .sin_port = htons(port), 1063 }; 1064 const char *netid; 1065 int error; 1066 1067 switch (protocol) { 1068 case IPPROTO_UDP: 1069 netid = RPCBIND_NETID_UDP; 1070 break; 1071 case IPPROTO_TCP: 1072 netid = RPCBIND_NETID_TCP; 1073 break; 1074 default: 1075 return -ENOPROTOOPT; 1076 } 1077 1078 error = rpcb_v4_register(net, program, version, 1079 (const struct sockaddr *)&sin, netid); 1080 1081 /* 1082 * User space didn't support rpcbind v4, so retry this 1083 * registration request with the legacy rpcbind v2 protocol. 1084 */ 1085 if (error == -EPROTONOSUPPORT) 1086 error = rpcb_register(net, program, version, protocol, port); 1087 1088 return error; 1089 } 1090 1091 #if IS_ENABLED(CONFIG_IPV6) 1092 /* 1093 * Register an "inet6" protocol family netid with the local 1094 * rpcbind daemon via an rpcbind v4 SET request. 1095 * 1096 * No netconfig infrastructure is available in the kernel, so 1097 * we map IP_ protocol numbers to netids by hand. 1098 * 1099 * Returns zero on success; a negative errno value is returned 1100 * if any error occurs. 1101 */ 1102 static int __svc_rpcb_register6(struct net *net, const u32 program, 1103 const u32 version, 1104 const unsigned short protocol, 1105 const unsigned short port) 1106 { 1107 const struct sockaddr_in6 sin6 = { 1108 .sin6_family = AF_INET6, 1109 .sin6_addr = IN6ADDR_ANY_INIT, 1110 .sin6_port = htons(port), 1111 }; 1112 const char *netid; 1113 int error; 1114 1115 switch (protocol) { 1116 case IPPROTO_UDP: 1117 netid = RPCBIND_NETID_UDP6; 1118 break; 1119 case IPPROTO_TCP: 1120 netid = RPCBIND_NETID_TCP6; 1121 break; 1122 default: 1123 return -ENOPROTOOPT; 1124 } 1125 1126 error = rpcb_v4_register(net, program, version, 1127 (const struct sockaddr *)&sin6, netid); 1128 1129 /* 1130 * User space didn't support rpcbind version 4, so we won't 1131 * use a PF_INET6 listener. 1132 */ 1133 if (error == -EPROTONOSUPPORT) 1134 error = -EAFNOSUPPORT; 1135 1136 return error; 1137 } 1138 #endif /* IS_ENABLED(CONFIG_IPV6) */ 1139 1140 /* 1141 * Register a kernel RPC service via rpcbind version 4. 1142 * 1143 * Returns zero on success; a negative errno value is returned 1144 * if any error occurs. 1145 */ 1146 static int __svc_register(struct net *net, const char *progname, 1147 const u32 program, const u32 version, 1148 const int family, 1149 const unsigned short protocol, 1150 const unsigned short port) 1151 { 1152 int error = -EAFNOSUPPORT; 1153 1154 switch (family) { 1155 case PF_INET: 1156 error = __svc_rpcb_register4(net, program, version, 1157 protocol, port); 1158 break; 1159 #if IS_ENABLED(CONFIG_IPV6) 1160 case PF_INET6: 1161 error = __svc_rpcb_register6(net, program, version, 1162 protocol, port); 1163 #endif 1164 } 1165 1166 trace_svc_register(progname, version, family, protocol, port, error); 1167 return error; 1168 } 1169 1170 static 1171 int svc_rpcbind_set_version(struct net *net, 1172 const struct svc_program *progp, 1173 u32 version, int family, 1174 unsigned short proto, 1175 unsigned short port) 1176 { 1177 return __svc_register(net, progp->pg_name, progp->pg_prog, 1178 version, family, proto, port); 1179 1180 } 1181 1182 int svc_generic_rpcbind_set(struct net *net, 1183 const struct svc_program *progp, 1184 u32 version, int family, 1185 unsigned short proto, 1186 unsigned short port) 1187 { 1188 const struct svc_version *vers = progp->pg_vers[version]; 1189 int error; 1190 1191 if (vers == NULL) 1192 return 0; 1193 1194 if (vers->vs_hidden) { 1195 trace_svc_noregister(progp->pg_name, version, proto, 1196 port, family, 0); 1197 return 0; 1198 } 1199 1200 /* 1201 * Don't register a UDP port if we need congestion 1202 * control. 1203 */ 1204 if (vers->vs_need_cong_ctrl && proto == IPPROTO_UDP) 1205 return 0; 1206 1207 error = svc_rpcbind_set_version(net, progp, version, 1208 family, proto, port); 1209 1210 return (vers->vs_rpcb_optnl) ? 0 : error; 1211 } 1212 EXPORT_SYMBOL_GPL(svc_generic_rpcbind_set); 1213 1214 /** 1215 * svc_register - register an RPC service with the local portmapper 1216 * @serv: svc_serv struct for the service to register 1217 * @net: net namespace for the service to register 1218 * @family: protocol family of service's listener socket 1219 * @proto: transport protocol number to advertise 1220 * @port: port to advertise 1221 * 1222 * Service is registered for any address in the passed-in protocol family 1223 */ 1224 int svc_register(const struct svc_serv *serv, struct net *net, 1225 const int family, const unsigned short proto, 1226 const unsigned short port) 1227 { 1228 unsigned int p, i; 1229 int error = 0; 1230 1231 WARN_ON_ONCE(proto == 0 && port == 0); 1232 if (proto == 0 && port == 0) 1233 return -EINVAL; 1234 1235 for (p = 0; p < serv->sv_nprogs; p++) { 1236 struct svc_program *progp = &serv->sv_programs[p]; 1237 1238 for (i = 0; i < progp->pg_nvers; i++) { 1239 1240 error = progp->pg_rpcbind_set(net, progp, i, 1241 family, proto, port); 1242 if (error < 0) { 1243 printk(KERN_WARNING "svc: failed to register " 1244 "%sv%u RPC service (errno %d).\n", 1245 progp->pg_name, i, -error); 1246 break; 1247 } 1248 } 1249 } 1250 1251 return error; 1252 } 1253 1254 /* 1255 * If user space is running rpcbind, it should take the v4 UNSET 1256 * and clear everything for this [program, version]. If user space 1257 * is running portmap, it will reject the v4 UNSET, but won't have 1258 * any "inet6" entries anyway. So a PMAP_UNSET should be sufficient 1259 * in this case to clear all existing entries for [program, version]. 1260 */ 1261 static void __svc_unregister(struct net *net, const u32 program, const u32 version, 1262 const char *progname) 1263 { 1264 int error; 1265 1266 error = rpcb_v4_register(net, program, version, NULL, ""); 1267 1268 /* 1269 * User space didn't support rpcbind v4, so retry this 1270 * request with the legacy rpcbind v2 protocol. 1271 */ 1272 if (error == -EPROTONOSUPPORT) 1273 error = rpcb_register(net, program, version, 0, 0); 1274 1275 trace_svc_unregister(progname, version, error); 1276 } 1277 1278 /* 1279 * All netids, bind addresses and ports registered for [program, version] 1280 * are removed from the local rpcbind database (if the service is not 1281 * hidden) to make way for a new instance of the service. 1282 * 1283 * The result of unregistration is reported via dprintk for those who want 1284 * verification of the result, but is otherwise not important. 1285 */ 1286 static void svc_unregister(const struct svc_serv *serv, struct net *net) 1287 { 1288 struct sighand_struct *sighand; 1289 unsigned long flags; 1290 unsigned int p, i; 1291 1292 clear_thread_flag(TIF_SIGPENDING); 1293 1294 for (p = 0; p < serv->sv_nprogs; p++) { 1295 struct svc_program *progp = &serv->sv_programs[p]; 1296 1297 for (i = 0; i < progp->pg_nvers; i++) { 1298 if (progp->pg_vers[i] == NULL) 1299 continue; 1300 if (progp->pg_vers[i]->vs_hidden) 1301 continue; 1302 __svc_unregister(net, progp->pg_prog, i, progp->pg_name); 1303 } 1304 } 1305 1306 rcu_read_lock(); 1307 sighand = rcu_dereference(current->sighand); 1308 spin_lock_irqsave(&sighand->siglock, flags); 1309 recalc_sigpending(); 1310 spin_unlock_irqrestore(&sighand->siglock, flags); 1311 rcu_read_unlock(); 1312 } 1313 1314 /* 1315 * dprintk the given error with the address of the client that caused it. 1316 */ 1317 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) 1318 static __printf(2, 3) 1319 void svc_printk(struct svc_rqst *rqstp, const char *fmt, ...) 1320 { 1321 struct va_format vaf; 1322 va_list args; 1323 char buf[RPC_MAX_ADDRBUFLEN]; 1324 1325 va_start(args, fmt); 1326 1327 vaf.fmt = fmt; 1328 vaf.va = &args; 1329 1330 dprintk("svc: %s: %pV", svc_print_addr(rqstp, buf, sizeof(buf)), &vaf); 1331 1332 va_end(args); 1333 } 1334 #else 1335 static __printf(2,3) void svc_printk(struct svc_rqst *rqstp, const char *fmt, ...) {} 1336 #endif 1337 1338 __be32 1339 svc_generic_init_request(struct svc_rqst *rqstp, 1340 const struct svc_program *progp, 1341 struct svc_process_info *ret) 1342 { 1343 const struct svc_version *versp = NULL; /* compiler food */ 1344 const struct svc_procedure *procp = NULL; 1345 1346 if (rqstp->rq_vers >= progp->pg_nvers ) 1347 goto err_bad_vers; 1348 versp = progp->pg_vers[rqstp->rq_vers]; 1349 if (!versp) 1350 goto err_bad_vers; 1351 1352 /* 1353 * Some protocol versions (namely NFSv4) require some form of 1354 * congestion control. (See RFC 7530 section 3.1 paragraph 2) 1355 * In other words, UDP is not allowed. We mark those when setting 1356 * up the svc_xprt, and verify that here. 1357 * 1358 * The spec is not very clear about what error should be returned 1359 * when someone tries to access a server that is listening on UDP 1360 * for lower versions. RPC_PROG_MISMATCH seems to be the closest 1361 * fit. 1362 */ 1363 if (versp->vs_need_cong_ctrl && rqstp->rq_xprt && 1364 !test_bit(XPT_CONG_CTRL, &rqstp->rq_xprt->xpt_flags)) 1365 goto err_bad_vers; 1366 1367 if (rqstp->rq_proc >= versp->vs_nproc) 1368 goto err_bad_proc; 1369 rqstp->rq_procinfo = procp = &versp->vs_proc[rqstp->rq_proc]; 1370 1371 /* Initialize storage for argp and resp */ 1372 memset(rqstp->rq_argp, 0, procp->pc_argzero); 1373 memset(rqstp->rq_resp, 0, procp->pc_ressize); 1374 1375 /* Bump per-procedure stats counter */ 1376 this_cpu_inc(versp->vs_count[rqstp->rq_proc]); 1377 1378 ret->dispatch = versp->vs_dispatch; 1379 return rpc_success; 1380 err_bad_vers: 1381 ret->mismatch.lovers = progp->pg_lovers; 1382 ret->mismatch.hivers = progp->pg_hivers; 1383 return rpc_prog_mismatch; 1384 err_bad_proc: 1385 return rpc_proc_unavail; 1386 } 1387 EXPORT_SYMBOL_GPL(svc_generic_init_request); 1388 1389 /* 1390 * Common routine for processing the RPC request. 1391 */ 1392 static int 1393 svc_process_common(struct svc_rqst *rqstp) 1394 { 1395 struct xdr_stream *xdr = &rqstp->rq_res_stream; 1396 struct svc_program *progp = NULL; 1397 const struct svc_procedure *procp = NULL; 1398 struct svc_serv *serv = rqstp->rq_server; 1399 struct svc_process_info process; 1400 enum svc_auth_status auth_res; 1401 unsigned int aoffset; 1402 int pr, rc; 1403 __be32 *p; 1404 1405 /* Reset the accept_stat for the RPC */ 1406 rqstp->rq_accept_statp = NULL; 1407 1408 /* Will be turned off only when NFSv4 Sessions are used */ 1409 set_bit(RQ_USEDEFERRAL, &rqstp->rq_flags); 1410 clear_bit(RQ_DROPME, &rqstp->rq_flags); 1411 1412 /* Construct the first words of the reply: */ 1413 svcxdr_init_encode(rqstp); 1414 xdr_stream_encode_be32(xdr, rqstp->rq_xid); 1415 xdr_stream_encode_be32(xdr, rpc_reply); 1416 1417 p = xdr_inline_decode(&rqstp->rq_arg_stream, XDR_UNIT * 4); 1418 if (unlikely(!p)) 1419 goto err_short_len; 1420 if (*p++ != cpu_to_be32(RPC_VERSION)) 1421 goto err_bad_rpc; 1422 1423 xdr_stream_encode_be32(xdr, rpc_msg_accepted); 1424 1425 rqstp->rq_prog = be32_to_cpup(p++); 1426 rqstp->rq_vers = be32_to_cpup(p++); 1427 rqstp->rq_proc = be32_to_cpup(p); 1428 1429 for (pr = 0; pr < serv->sv_nprogs; pr++) 1430 if (rqstp->rq_prog == serv->sv_programs[pr].pg_prog) 1431 progp = &serv->sv_programs[pr]; 1432 1433 /* 1434 * Decode auth data, and add verifier to reply buffer. 1435 * We do this before anything else in order to get a decent 1436 * auth verifier. 1437 */ 1438 auth_res = svc_authenticate(rqstp); 1439 /* Also give the program a chance to reject this call: */ 1440 if (auth_res == SVC_OK && progp) 1441 auth_res = progp->pg_authenticate(rqstp); 1442 trace_svc_authenticate(rqstp, auth_res); 1443 switch (auth_res) { 1444 case SVC_OK: 1445 break; 1446 case SVC_GARBAGE: 1447 rqstp->rq_auth_stat = rpc_autherr_badcred; 1448 goto err_bad_auth; 1449 case SVC_DENIED: 1450 goto err_bad_auth; 1451 case SVC_CLOSE: 1452 goto close; 1453 case SVC_DROP: 1454 goto dropit; 1455 case SVC_COMPLETE: 1456 goto sendit; 1457 default: 1458 pr_warn_once("Unexpected svc_auth_status (%d)\n", auth_res); 1459 rqstp->rq_auth_stat = rpc_autherr_failed; 1460 goto err_bad_auth; 1461 } 1462 1463 if (progp == NULL) 1464 goto err_bad_prog; 1465 1466 switch (progp->pg_init_request(rqstp, progp, &process)) { 1467 case rpc_success: 1468 break; 1469 case rpc_prog_unavail: 1470 goto err_bad_prog; 1471 case rpc_prog_mismatch: 1472 goto err_bad_vers; 1473 case rpc_proc_unavail: 1474 goto err_bad_proc; 1475 } 1476 1477 procp = rqstp->rq_procinfo; 1478 /* Should this check go into the dispatcher? */ 1479 if (!procp || !procp->pc_func) 1480 goto err_bad_proc; 1481 1482 /* Syntactic check complete */ 1483 if (serv->sv_stats) 1484 serv->sv_stats->rpccnt++; 1485 trace_svc_process(rqstp, progp->pg_name); 1486 1487 aoffset = xdr_stream_pos(xdr); 1488 1489 /* un-reserve some of the out-queue now that we have a 1490 * better idea of reply size 1491 */ 1492 if (procp->pc_xdrressize) 1493 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2); 1494 1495 /* Call the function that processes the request. */ 1496 rc = process.dispatch(rqstp); 1497 xdr_finish_decode(xdr); 1498 1499 if (!rc) 1500 goto dropit; 1501 if (rqstp->rq_auth_stat != rpc_auth_ok) 1502 goto err_bad_auth; 1503 1504 if (*rqstp->rq_accept_statp != rpc_success) 1505 xdr_truncate_encode(xdr, aoffset); 1506 1507 if (procp->pc_encode == NULL) 1508 goto dropit; 1509 1510 sendit: 1511 if (svc_authorise(rqstp)) 1512 goto close_xprt; 1513 return 1; /* Caller can now send it */ 1514 1515 dropit: 1516 svc_authorise(rqstp); /* doesn't hurt to call this twice */ 1517 dprintk("svc: svc_process dropit\n"); 1518 return 0; 1519 1520 close: 1521 svc_authorise(rqstp); 1522 close_xprt: 1523 if (rqstp->rq_xprt && test_bit(XPT_TEMP, &rqstp->rq_xprt->xpt_flags)) 1524 svc_xprt_close(rqstp->rq_xprt); 1525 dprintk("svc: svc_process close\n"); 1526 return 0; 1527 1528 err_short_len: 1529 svc_printk(rqstp, "short len %u, dropping request\n", 1530 rqstp->rq_arg.len); 1531 goto close_xprt; 1532 1533 err_bad_rpc: 1534 if (serv->sv_stats) 1535 serv->sv_stats->rpcbadfmt++; 1536 xdr_stream_encode_u32(xdr, RPC_MSG_DENIED); 1537 xdr_stream_encode_u32(xdr, RPC_MISMATCH); 1538 /* Only RPCv2 supported */ 1539 xdr_stream_encode_u32(xdr, RPC_VERSION); 1540 xdr_stream_encode_u32(xdr, RPC_VERSION); 1541 return 1; /* don't wrap */ 1542 1543 err_bad_auth: 1544 dprintk("svc: authentication failed (%d)\n", 1545 be32_to_cpu(rqstp->rq_auth_stat)); 1546 if (serv->sv_stats) 1547 serv->sv_stats->rpcbadauth++; 1548 /* Restore write pointer to location of reply status: */ 1549 xdr_truncate_encode(xdr, XDR_UNIT * 2); 1550 xdr_stream_encode_u32(xdr, RPC_MSG_DENIED); 1551 xdr_stream_encode_u32(xdr, RPC_AUTH_ERROR); 1552 xdr_stream_encode_be32(xdr, rqstp->rq_auth_stat); 1553 goto sendit; 1554 1555 err_bad_prog: 1556 dprintk("svc: unknown program %d\n", rqstp->rq_prog); 1557 if (serv->sv_stats) 1558 serv->sv_stats->rpcbadfmt++; 1559 *rqstp->rq_accept_statp = rpc_prog_unavail; 1560 goto sendit; 1561 1562 err_bad_vers: 1563 svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n", 1564 rqstp->rq_vers, rqstp->rq_prog, progp->pg_name); 1565 1566 if (serv->sv_stats) 1567 serv->sv_stats->rpcbadfmt++; 1568 *rqstp->rq_accept_statp = rpc_prog_mismatch; 1569 1570 /* 1571 * svc_authenticate() has already added the verifier and 1572 * advanced the stream just past rq_accept_statp. 1573 */ 1574 xdr_stream_encode_u32(xdr, process.mismatch.lovers); 1575 xdr_stream_encode_u32(xdr, process.mismatch.hivers); 1576 goto sendit; 1577 1578 err_bad_proc: 1579 svc_printk(rqstp, "unknown procedure (%d)\n", rqstp->rq_proc); 1580 1581 if (serv->sv_stats) 1582 serv->sv_stats->rpcbadfmt++; 1583 *rqstp->rq_accept_statp = rpc_proc_unavail; 1584 goto sendit; 1585 } 1586 1587 /* 1588 * Drop request 1589 */ 1590 static void svc_drop(struct svc_rqst *rqstp) 1591 { 1592 trace_svc_drop(rqstp); 1593 } 1594 1595 static void svc_release_rqst(struct svc_rqst *rqstp) 1596 { 1597 const struct svc_procedure *procp = rqstp->rq_procinfo; 1598 1599 if (procp && procp->pc_release) 1600 procp->pc_release(rqstp); 1601 } 1602 1603 /** 1604 * svc_process - Execute one RPC transaction 1605 * @rqstp: RPC transaction context 1606 * 1607 */ 1608 void svc_process(struct svc_rqst *rqstp) 1609 { 1610 struct kvec *resv = &rqstp->rq_res.head[0]; 1611 __be32 *p; 1612 1613 #if IS_ENABLED(CONFIG_FAIL_SUNRPC) 1614 if (!fail_sunrpc.ignore_server_disconnect && 1615 should_fail(&fail_sunrpc.attr, 1)) 1616 svc_xprt_deferred_close(rqstp->rq_xprt); 1617 #endif 1618 1619 /* 1620 * Setup response xdr_buf. 1621 * Initially it has just one page 1622 */ 1623 rqstp->rq_next_page = &rqstp->rq_respages[1]; 1624 resv->iov_base = page_address(rqstp->rq_respages[0]); 1625 resv->iov_len = 0; 1626 rqstp->rq_res.pages = rqstp->rq_next_page; 1627 rqstp->rq_res.len = 0; 1628 rqstp->rq_res.page_base = 0; 1629 rqstp->rq_res.page_len = 0; 1630 rqstp->rq_res.buflen = PAGE_SIZE; 1631 rqstp->rq_res.tail[0].iov_base = NULL; 1632 rqstp->rq_res.tail[0].iov_len = 0; 1633 1634 svcxdr_init_decode(rqstp); 1635 p = xdr_inline_decode(&rqstp->rq_arg_stream, XDR_UNIT * 2); 1636 if (unlikely(!p)) 1637 goto out_drop; 1638 rqstp->rq_xid = *p++; 1639 if (unlikely(*p != rpc_call)) 1640 goto out_baddir; 1641 1642 if (!svc_process_common(rqstp)) { 1643 svc_release_rqst(rqstp); 1644 goto out_drop; 1645 } 1646 svc_send(rqstp); 1647 svc_release_rqst(rqstp); 1648 return; 1649 1650 out_baddir: 1651 svc_printk(rqstp, "bad direction 0x%08x, dropping request\n", 1652 be32_to_cpu(*p)); 1653 if (rqstp->rq_server->sv_stats) 1654 rqstp->rq_server->sv_stats->rpcbadfmt++; 1655 out_drop: 1656 svc_drop(rqstp); 1657 } 1658 1659 #if defined(CONFIG_SUNRPC_BACKCHANNEL) 1660 /** 1661 * svc_process_bc - process a reverse-direction RPC request 1662 * @req: RPC request to be used for client-side processing 1663 * @rqstp: server-side execution context 1664 * 1665 */ 1666 void svc_process_bc(struct rpc_rqst *req, struct svc_rqst *rqstp) 1667 { 1668 struct rpc_timeout timeout = { 1669 .to_increment = 0, 1670 }; 1671 struct rpc_task *task; 1672 int proc_error; 1673 1674 /* Build the svc_rqst used by the common processing routine */ 1675 rqstp->rq_xid = req->rq_xid; 1676 rqstp->rq_prot = req->rq_xprt->prot; 1677 rqstp->rq_bc_net = req->rq_xprt->xprt_net; 1678 1679 rqstp->rq_addrlen = sizeof(req->rq_xprt->addr); 1680 memcpy(&rqstp->rq_addr, &req->rq_xprt->addr, rqstp->rq_addrlen); 1681 memcpy(&rqstp->rq_arg, &req->rq_rcv_buf, sizeof(rqstp->rq_arg)); 1682 memcpy(&rqstp->rq_res, &req->rq_snd_buf, sizeof(rqstp->rq_res)); 1683 1684 /* Adjust the argument buffer length */ 1685 rqstp->rq_arg.len = req->rq_private_buf.len; 1686 if (rqstp->rq_arg.len <= rqstp->rq_arg.head[0].iov_len) { 1687 rqstp->rq_arg.head[0].iov_len = rqstp->rq_arg.len; 1688 rqstp->rq_arg.page_len = 0; 1689 } else if (rqstp->rq_arg.len <= rqstp->rq_arg.head[0].iov_len + 1690 rqstp->rq_arg.page_len) 1691 rqstp->rq_arg.page_len = rqstp->rq_arg.len - 1692 rqstp->rq_arg.head[0].iov_len; 1693 else 1694 rqstp->rq_arg.len = rqstp->rq_arg.head[0].iov_len + 1695 rqstp->rq_arg.page_len; 1696 1697 /* Reset the response buffer */ 1698 rqstp->rq_res.head[0].iov_len = 0; 1699 1700 /* 1701 * Skip the XID and calldir fields because they've already 1702 * been processed by the caller. 1703 */ 1704 svcxdr_init_decode(rqstp); 1705 if (!xdr_inline_decode(&rqstp->rq_arg_stream, XDR_UNIT * 2)) 1706 return; 1707 1708 /* Parse and execute the bc call */ 1709 proc_error = svc_process_common(rqstp); 1710 1711 atomic_dec(&req->rq_xprt->bc_slot_count); 1712 if (!proc_error) { 1713 /* Processing error: drop the request */ 1714 xprt_free_bc_request(req); 1715 svc_release_rqst(rqstp); 1716 return; 1717 } 1718 /* Finally, send the reply synchronously */ 1719 if (rqstp->bc_to_initval > 0) { 1720 timeout.to_initval = rqstp->bc_to_initval; 1721 timeout.to_retries = rqstp->bc_to_retries; 1722 } else { 1723 timeout.to_initval = req->rq_xprt->timeout->to_initval; 1724 timeout.to_retries = req->rq_xprt->timeout->to_retries; 1725 } 1726 timeout.to_maxval = timeout.to_initval; 1727 memcpy(&req->rq_snd_buf, &rqstp->rq_res, sizeof(req->rq_snd_buf)); 1728 task = rpc_run_bc_task(req, &timeout); 1729 svc_release_rqst(rqstp); 1730 1731 if (IS_ERR(task)) 1732 return; 1733 1734 WARN_ON_ONCE(atomic_read(&task->tk_count) != 1); 1735 rpc_put_task(task); 1736 } 1737 #endif /* CONFIG_SUNRPC_BACKCHANNEL */ 1738 1739 /** 1740 * svc_max_payload - Return transport-specific limit on the RPC payload 1741 * @rqstp: RPC transaction context 1742 * 1743 * Returns the maximum number of payload bytes the current transport 1744 * allows. 1745 */ 1746 u32 svc_max_payload(const struct svc_rqst *rqstp) 1747 { 1748 u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload; 1749 1750 if (rqstp->rq_server->sv_max_payload < max) 1751 max = rqstp->rq_server->sv_max_payload; 1752 return max; 1753 } 1754 EXPORT_SYMBOL_GPL(svc_max_payload); 1755 1756 /** 1757 * svc_proc_name - Return RPC procedure name in string form 1758 * @rqstp: svc_rqst to operate on 1759 * 1760 * Return value: 1761 * Pointer to a NUL-terminated string 1762 */ 1763 const char *svc_proc_name(const struct svc_rqst *rqstp) 1764 { 1765 if (rqstp && rqstp->rq_procinfo) 1766 return rqstp->rq_procinfo->pc_name; 1767 return "unknown"; 1768 } 1769 1770 1771 /** 1772 * svc_encode_result_payload - mark a range of bytes as a result payload 1773 * @rqstp: svc_rqst to operate on 1774 * @offset: payload's byte offset in rqstp->rq_res 1775 * @length: size of payload, in bytes 1776 * 1777 * Returns zero on success, or a negative errno if a permanent 1778 * error occurred. 1779 */ 1780 int svc_encode_result_payload(struct svc_rqst *rqstp, unsigned int offset, 1781 unsigned int length) 1782 { 1783 return rqstp->rq_xprt->xpt_ops->xpo_result_payload(rqstp, offset, 1784 length); 1785 } 1786 EXPORT_SYMBOL_GPL(svc_encode_result_payload); 1787 1788 /** 1789 * svc_fill_symlink_pathname - Construct pathname argument for VFS symlink call 1790 * @rqstp: svc_rqst to operate on 1791 * @first: buffer containing first section of pathname 1792 * @p: buffer containing remaining section of pathname 1793 * @total: total length of the pathname argument 1794 * 1795 * The VFS symlink API demands a NUL-terminated pathname in mapped memory. 1796 * Returns pointer to a NUL-terminated string, or an ERR_PTR. Caller must free 1797 * the returned string. 1798 */ 1799 char *svc_fill_symlink_pathname(struct svc_rqst *rqstp, struct kvec *first, 1800 void *p, size_t total) 1801 { 1802 size_t len, remaining; 1803 char *result, *dst; 1804 1805 result = kmalloc(total + 1, GFP_KERNEL); 1806 if (!result) 1807 return ERR_PTR(-ESERVERFAULT); 1808 1809 dst = result; 1810 remaining = total; 1811 1812 len = min_t(size_t, total, first->iov_len); 1813 if (len) { 1814 memcpy(dst, first->iov_base, len); 1815 dst += len; 1816 remaining -= len; 1817 } 1818 1819 if (remaining) { 1820 len = min_t(size_t, remaining, PAGE_SIZE); 1821 memcpy(dst, p, len); 1822 dst += len; 1823 } 1824 1825 *dst = '\0'; 1826 1827 /* Sanity check: Linux doesn't allow the pathname argument to 1828 * contain a NUL byte. 1829 */ 1830 if (strlen(result) != total) { 1831 kfree(result); 1832 return ERR_PTR(-EINVAL); 1833 } 1834 return result; 1835 } 1836 EXPORT_SYMBOL_GPL(svc_fill_symlink_pathname); 1837