2 * linux/net/sunrpc/svc.c
4 * High-level RPC service routines
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
8 * Multiple threads pools and NUMAisation
9 * Copyright (c) 2006 Silicon Graphics, Inc.
10 * by Greg Banks <gnb@melbourne.sgi.com>
13 #include <linux/linkage.h>
14 #include <linux/sched.h>
15 #include <linux/errno.h>
16 #include <linux/net.h>
19 #include <linux/interrupt.h>
20 #include <linux/module.h>
21 #include <linux/kthread.h>
22 #include <linux/slab.h>
23 #include <linux/nsproxy.h>
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>
32 #define RPCDBG_FACILITY RPCDBG_SVCDSP
34 static void svc_unregister(const struct svc_serv *serv, struct net *net);
36 #define svc_serv_is_pooled(serv) ((serv)->sv_function)
39 * Mode for mapping cpus to pools.
42 SVC_POOL_AUTO = -1, /* choose one of the others */
43 SVC_POOL_GLOBAL, /* no mapping, just a single global pool
44 * (legacy & UP mode) */
45 SVC_POOL_PERCPU, /* one pool per cpu */
46 SVC_POOL_PERNODE /* one pool per numa node */
48 #define SVC_POOL_DEFAULT SVC_POOL_GLOBAL
51 * Structure for mapping cpus to pools and vice versa.
52 * Setup once during sunrpc initialisation.
54 static struct svc_pool_map {
55 int count; /* How many svc_servs use us */
56 int mode; /* Note: int not enum to avoid
57 * warnings about "enumeration value
58 * not handled in switch" */
60 unsigned int *pool_to; /* maps pool id to cpu or node */
61 unsigned int *to_pool; /* maps cpu or node to pool id */
64 .mode = SVC_POOL_DEFAULT
66 static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
69 param_set_pool_mode(const char *val, struct kernel_param *kp)
71 int *ip = (int *)kp->arg;
72 struct svc_pool_map *m = &svc_pool_map;
75 mutex_lock(&svc_pool_map_mutex);
82 if (!strncmp(val, "auto", 4))
84 else if (!strncmp(val, "global", 6))
85 *ip = SVC_POOL_GLOBAL;
86 else if (!strncmp(val, "percpu", 6))
87 *ip = SVC_POOL_PERCPU;
88 else if (!strncmp(val, "pernode", 7))
89 *ip = SVC_POOL_PERNODE;
94 mutex_unlock(&svc_pool_map_mutex);
99 param_get_pool_mode(char *buf, struct kernel_param *kp)
101 int *ip = (int *)kp->arg;
106 return strlcpy(buf, "auto", 20);
107 case SVC_POOL_GLOBAL:
108 return strlcpy(buf, "global", 20);
109 case SVC_POOL_PERCPU:
110 return strlcpy(buf, "percpu", 20);
111 case SVC_POOL_PERNODE:
112 return strlcpy(buf, "pernode", 20);
114 return sprintf(buf, "%d", *ip);
118 module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
119 &svc_pool_map.mode, 0644);
122 * Detect best pool mapping mode heuristically,
123 * according to the machine's topology.
126 svc_pool_map_choose_mode(void)
130 if (nr_online_nodes > 1) {
132 * Actually have multiple NUMA nodes,
133 * so split pools on NUMA node boundaries
135 return SVC_POOL_PERNODE;
138 node = first_online_node;
139 if (nr_cpus_node(node) > 2) {
141 * Non-trivial SMP, or CONFIG_NUMA on
142 * non-NUMA hardware, e.g. with a generic
143 * x86_64 kernel on Xeons. In this case we
144 * want to divide the pools on cpu boundaries.
146 return SVC_POOL_PERCPU;
149 /* default: one global pool */
150 return SVC_POOL_GLOBAL;
154 * Allocate the to_pool[] and pool_to[] arrays.
155 * Returns 0 on success or an errno.
158 svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools)
160 m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
163 m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
177 * Initialise the pool map for SVC_POOL_PERCPU mode.
178 * Returns number of pools or <0 on error.
181 svc_pool_map_init_percpu(struct svc_pool_map *m)
183 unsigned int maxpools = nr_cpu_ids;
184 unsigned int pidx = 0;
188 err = svc_pool_map_alloc_arrays(m, maxpools);
192 for_each_online_cpu(cpu) {
193 BUG_ON(pidx > maxpools);
194 m->to_pool[cpu] = pidx;
195 m->pool_to[pidx] = cpu;
198 /* cpus brought online later all get mapped to pool0, sorry */
205 * Initialise the pool map for SVC_POOL_PERNODE mode.
206 * Returns number of pools or <0 on error.
209 svc_pool_map_init_pernode(struct svc_pool_map *m)
211 unsigned int maxpools = nr_node_ids;
212 unsigned int pidx = 0;
216 err = svc_pool_map_alloc_arrays(m, maxpools);
220 for_each_node_with_cpus(node) {
221 /* some architectures (e.g. SN2) have cpuless nodes */
222 BUG_ON(pidx > maxpools);
223 m->to_pool[node] = pidx;
224 m->pool_to[pidx] = node;
227 /* nodes brought online later all get mapped to pool0, sorry */
234 * Add a reference to the global map of cpus to pools (and
235 * vice versa). Initialise the map if we're the first user.
236 * Returns the number of pools.
239 svc_pool_map_get(void)
241 struct svc_pool_map *m = &svc_pool_map;
244 mutex_lock(&svc_pool_map_mutex);
247 mutex_unlock(&svc_pool_map_mutex);
251 if (m->mode == SVC_POOL_AUTO)
252 m->mode = svc_pool_map_choose_mode();
255 case SVC_POOL_PERCPU:
256 npools = svc_pool_map_init_percpu(m);
258 case SVC_POOL_PERNODE:
259 npools = svc_pool_map_init_pernode(m);
264 /* default, or memory allocation failure */
266 m->mode = SVC_POOL_GLOBAL;
270 mutex_unlock(&svc_pool_map_mutex);
276 * Drop a reference to the global map of cpus to pools.
277 * When the last reference is dropped, the map data is
278 * freed; this allows the sysadmin to change the pool
279 * mode using the pool_mode module option without
280 * rebooting or re-loading sunrpc.ko.
283 svc_pool_map_put(void)
285 struct svc_pool_map *m = &svc_pool_map;
287 mutex_lock(&svc_pool_map_mutex);
297 mutex_unlock(&svc_pool_map_mutex);
301 static int svc_pool_map_get_node(unsigned int pidx)
303 const struct svc_pool_map *m = &svc_pool_map;
306 if (m->mode == SVC_POOL_PERCPU)
307 return cpu_to_node(m->pool_to[pidx]);
308 if (m->mode == SVC_POOL_PERNODE)
309 return m->pool_to[pidx];
314 * Set the given thread's cpus_allowed mask so that it
315 * will only run on cpus in the given pool.
318 svc_pool_map_set_cpumask(struct task_struct *task, unsigned int pidx)
320 struct svc_pool_map *m = &svc_pool_map;
321 unsigned int node = m->pool_to[pidx];
324 * The caller checks for sv_nrpools > 1, which
325 * implies that we've been initialized.
327 WARN_ON_ONCE(m->count == 0);
332 case SVC_POOL_PERCPU:
334 set_cpus_allowed_ptr(task, cpumask_of(node));
337 case SVC_POOL_PERNODE:
339 set_cpus_allowed_ptr(task, cpumask_of_node(node));
346 * Use the mapping mode to choose a pool for a given CPU.
347 * Used when enqueueing an incoming RPC. Always returns
348 * a non-NULL pool pointer.
351 svc_pool_for_cpu(struct svc_serv *serv, int cpu)
353 struct svc_pool_map *m = &svc_pool_map;
354 unsigned int pidx = 0;
357 * An uninitialised map happens in a pure client when
358 * lockd is brought up, so silently treat it the
359 * same as SVC_POOL_GLOBAL.
361 if (svc_serv_is_pooled(serv)) {
363 case SVC_POOL_PERCPU:
364 pidx = m->to_pool[cpu];
366 case SVC_POOL_PERNODE:
367 pidx = m->to_pool[cpu_to_node(cpu)];
371 return &serv->sv_pools[pidx % serv->sv_nrpools];
374 int svc_rpcb_setup(struct svc_serv *serv, struct net *net)
378 err = rpcb_create_local(net);
382 /* Remove any stale portmap registrations */
383 svc_unregister(serv, net);
386 EXPORT_SYMBOL_GPL(svc_rpcb_setup);
388 void svc_rpcb_cleanup(struct svc_serv *serv, struct net *net)
390 svc_unregister(serv, net);
393 EXPORT_SYMBOL_GPL(svc_rpcb_cleanup);
395 static int svc_uses_rpcbind(struct svc_serv *serv)
397 struct svc_program *progp;
400 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
401 for (i = 0; i < progp->pg_nvers; i++) {
402 if (progp->pg_vers[i] == NULL)
404 if (progp->pg_vers[i]->vs_hidden == 0)
412 int svc_bind(struct svc_serv *serv, struct net *net)
414 if (!svc_uses_rpcbind(serv))
416 return svc_rpcb_setup(serv, net);
418 EXPORT_SYMBOL_GPL(svc_bind);
421 * Create an RPC service
423 static struct svc_serv *
424 __svc_create(struct svc_program *prog, unsigned int bufsize, int npools,
425 void (*shutdown)(struct svc_serv *serv, struct net *net))
427 struct svc_serv *serv;
429 unsigned int xdrsize;
432 if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
434 serv->sv_name = prog->pg_name;
435 serv->sv_program = prog;
436 serv->sv_nrthreads = 1;
437 serv->sv_stats = prog->pg_stats;
438 if (bufsize > RPCSVC_MAXPAYLOAD)
439 bufsize = RPCSVC_MAXPAYLOAD;
440 serv->sv_max_payload = bufsize? bufsize : 4096;
441 serv->sv_max_mesg = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE);
442 serv->sv_shutdown = shutdown;
445 prog->pg_lovers = prog->pg_nvers-1;
446 for (vers=0; vers<prog->pg_nvers ; vers++)
447 if (prog->pg_vers[vers]) {
448 prog->pg_hivers = vers;
449 if (prog->pg_lovers > vers)
450 prog->pg_lovers = vers;
451 if (prog->pg_vers[vers]->vs_xdrsize > xdrsize)
452 xdrsize = prog->pg_vers[vers]->vs_xdrsize;
454 prog = prog->pg_next;
456 serv->sv_xdrsize = xdrsize;
457 INIT_LIST_HEAD(&serv->sv_tempsocks);
458 INIT_LIST_HEAD(&serv->sv_permsocks);
459 init_timer(&serv->sv_temptimer);
460 spin_lock_init(&serv->sv_lock);
462 serv->sv_nrpools = npools;
464 kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
466 if (!serv->sv_pools) {
471 for (i = 0; i < serv->sv_nrpools; i++) {
472 struct svc_pool *pool = &serv->sv_pools[i];
474 dprintk("svc: initialising pool %u for %s\n",
478 INIT_LIST_HEAD(&pool->sp_threads);
479 INIT_LIST_HEAD(&pool->sp_sockets);
480 INIT_LIST_HEAD(&pool->sp_all_threads);
481 spin_lock_init(&pool->sp_lock);
484 if (svc_uses_rpcbind(serv) && (!serv->sv_shutdown))
485 serv->sv_shutdown = svc_rpcb_cleanup;
491 svc_create(struct svc_program *prog, unsigned int bufsize,
492 void (*shutdown)(struct svc_serv *serv, struct net *net))
494 return __svc_create(prog, bufsize, /*npools*/1, shutdown);
496 EXPORT_SYMBOL_GPL(svc_create);
499 svc_create_pooled(struct svc_program *prog, unsigned int bufsize,
500 void (*shutdown)(struct svc_serv *serv, struct net *net),
501 svc_thread_fn func, struct module *mod)
503 struct svc_serv *serv;
504 unsigned int npools = svc_pool_map_get();
506 serv = __svc_create(prog, bufsize, npools, shutdown);
509 serv->sv_function = func;
510 serv->sv_module = mod;
515 EXPORT_SYMBOL_GPL(svc_create_pooled);
517 void svc_shutdown_net(struct svc_serv *serv, struct net *net)
520 * The set of xprts (contained in the sv_tempsocks and
521 * sv_permsocks lists) is now constant, since it is modified
522 * only by accepting new sockets (done by service threads in
523 * svc_recv) or aging old ones (done by sv_temptimer), or
524 * configuration changes (excluded by whatever locking the
525 * caller is using--nfsd_mutex in the case of nfsd). So it's
526 * safe to traverse those lists and shut everything down:
528 svc_close_net(serv, net);
530 if (serv->sv_shutdown)
531 serv->sv_shutdown(serv, net);
533 EXPORT_SYMBOL_GPL(svc_shutdown_net);
536 * Destroy an RPC service. Should be called with appropriate locking to
537 * protect the sv_nrthreads, sv_permsocks and sv_tempsocks.
540 svc_destroy(struct svc_serv *serv)
542 dprintk("svc: svc_destroy(%s, %d)\n",
543 serv->sv_program->pg_name,
546 if (serv->sv_nrthreads) {
547 if (--(serv->sv_nrthreads) != 0) {
548 svc_sock_update_bufs(serv);
552 printk("svc_destroy: no threads for serv=%p!\n", serv);
554 del_timer_sync(&serv->sv_temptimer);
557 * The last user is gone and thus all sockets have to be destroyed to
558 * the point. Check this.
560 BUG_ON(!list_empty(&serv->sv_permsocks));
561 BUG_ON(!list_empty(&serv->sv_tempsocks));
563 cache_clean_deferred(serv);
565 if (svc_serv_is_pooled(serv))
568 kfree(serv->sv_pools);
571 EXPORT_SYMBOL_GPL(svc_destroy);
574 * Allocate an RPC server's buffer space.
575 * We allocate pages and place them in rq_argpages.
578 svc_init_buffer(struct svc_rqst *rqstp, unsigned int size, int node)
580 unsigned int pages, arghi;
582 /* bc_xprt uses fore channel allocated buffers */
583 if (svc_is_backchannel(rqstp))
586 pages = size / PAGE_SIZE + 1; /* extra page as we hold both request and reply.
587 * We assume one is at most one page
590 WARN_ON_ONCE(pages > RPCSVC_MAXPAGES);
591 if (pages > RPCSVC_MAXPAGES)
592 pages = RPCSVC_MAXPAGES;
594 struct page *p = alloc_pages_node(node, GFP_KERNEL, 0);
597 rqstp->rq_pages[arghi++] = p;
604 * Release an RPC server buffer
607 svc_release_buffer(struct svc_rqst *rqstp)
611 for (i = 0; i < ARRAY_SIZE(rqstp->rq_pages); i++)
612 if (rqstp->rq_pages[i])
613 put_page(rqstp->rq_pages[i]);
617 svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool, int node)
619 struct svc_rqst *rqstp;
621 rqstp = kzalloc_node(sizeof(*rqstp), GFP_KERNEL, node);
625 init_waitqueue_head(&rqstp->rq_wait);
627 serv->sv_nrthreads++;
628 spin_lock_bh(&pool->sp_lock);
629 pool->sp_nrthreads++;
630 list_add(&rqstp->rq_all, &pool->sp_all_threads);
631 spin_unlock_bh(&pool->sp_lock);
632 rqstp->rq_server = serv;
633 rqstp->rq_pool = pool;
635 rqstp->rq_argp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
639 rqstp->rq_resp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
643 if (!svc_init_buffer(rqstp, serv->sv_max_mesg, node))
648 svc_exit_thread(rqstp);
650 return ERR_PTR(-ENOMEM);
652 EXPORT_SYMBOL_GPL(svc_prepare_thread);
655 * Choose a pool in which to create a new thread, for svc_set_num_threads
657 static inline struct svc_pool *
658 choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
663 return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
667 * Choose a thread to kill, for svc_set_num_threads
669 static inline struct task_struct *
670 choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
673 struct task_struct *task = NULL;
676 spin_lock_bh(&pool->sp_lock);
678 /* choose a pool in round-robin fashion */
679 for (i = 0; i < serv->sv_nrpools; i++) {
680 pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
681 spin_lock_bh(&pool->sp_lock);
682 if (!list_empty(&pool->sp_all_threads))
684 spin_unlock_bh(&pool->sp_lock);
690 if (!list_empty(&pool->sp_all_threads)) {
691 struct svc_rqst *rqstp;
694 * Remove from the pool->sp_all_threads list
695 * so we don't try to kill it again.
697 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
698 list_del_init(&rqstp->rq_all);
699 task = rqstp->rq_task;
701 spin_unlock_bh(&pool->sp_lock);
707 * Create or destroy enough new threads to make the number
708 * of threads the given number. If `pool' is non-NULL, applies
709 * only to threads in that pool, otherwise round-robins between
710 * all pools. Caller must ensure that mutual exclusion between this and
711 * server startup or shutdown.
713 * Destroying threads relies on the service threads filling in
714 * rqstp->rq_task, which only the nfs ones do. Assumes the serv
715 * has been created using svc_create_pooled().
717 * Based on code that used to be in nfsd_svc() but tweaked
721 svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
723 struct svc_rqst *rqstp;
724 struct task_struct *task;
725 struct svc_pool *chosen_pool;
727 unsigned int state = serv->sv_nrthreads-1;
731 /* The -1 assumes caller has done a svc_get() */
732 nrservs -= (serv->sv_nrthreads-1);
734 spin_lock_bh(&pool->sp_lock);
735 nrservs -= pool->sp_nrthreads;
736 spin_unlock_bh(&pool->sp_lock);
739 /* create new threads */
740 while (nrservs > 0) {
742 chosen_pool = choose_pool(serv, pool, &state);
744 node = svc_pool_map_get_node(chosen_pool->sp_id);
745 rqstp = svc_prepare_thread(serv, chosen_pool, node);
747 error = PTR_ERR(rqstp);
751 __module_get(serv->sv_module);
752 task = kthread_create_on_node(serv->sv_function, rqstp,
753 node, serv->sv_name);
755 error = PTR_ERR(task);
756 module_put(serv->sv_module);
757 svc_exit_thread(rqstp);
761 rqstp->rq_task = task;
762 if (serv->sv_nrpools > 1)
763 svc_pool_map_set_cpumask(task, chosen_pool->sp_id);
765 svc_sock_update_bufs(serv);
766 wake_up_process(task);
768 /* destroy old threads */
769 while (nrservs < 0 &&
770 (task = choose_victim(serv, pool, &state)) != NULL) {
771 send_sig(SIGINT, task, 1);
777 EXPORT_SYMBOL_GPL(svc_set_num_threads);
780 * Called from a server thread as it's exiting. Caller must hold the BKL or
781 * the "service mutex", whichever is appropriate for the service.
784 svc_exit_thread(struct svc_rqst *rqstp)
786 struct svc_serv *serv = rqstp->rq_server;
787 struct svc_pool *pool = rqstp->rq_pool;
789 svc_release_buffer(rqstp);
790 kfree(rqstp->rq_resp);
791 kfree(rqstp->rq_argp);
792 kfree(rqstp->rq_auth_data);
794 spin_lock_bh(&pool->sp_lock);
795 pool->sp_nrthreads--;
796 list_del(&rqstp->rq_all);
797 spin_unlock_bh(&pool->sp_lock);
801 /* Release the server */
805 EXPORT_SYMBOL_GPL(svc_exit_thread);
808 * Register an "inet" protocol family netid with the local
809 * rpcbind daemon via an rpcbind v4 SET request.
811 * No netconfig infrastructure is available in the kernel, so
812 * we map IP_ protocol numbers to netids by hand.
814 * Returns zero on success; a negative errno value is returned
815 * if any error occurs.
817 static int __svc_rpcb_register4(struct net *net, const u32 program,
819 const unsigned short protocol,
820 const unsigned short port)
822 const struct sockaddr_in sin = {
823 .sin_family = AF_INET,
824 .sin_addr.s_addr = htonl(INADDR_ANY),
825 .sin_port = htons(port),
832 netid = RPCBIND_NETID_UDP;
835 netid = RPCBIND_NETID_TCP;
841 error = rpcb_v4_register(net, program, version,
842 (const struct sockaddr *)&sin, netid);
845 * User space didn't support rpcbind v4, so retry this
846 * registration request with the legacy rpcbind v2 protocol.
848 if (error == -EPROTONOSUPPORT)
849 error = rpcb_register(net, program, version, protocol, port);
854 #if IS_ENABLED(CONFIG_IPV6)
856 * Register an "inet6" protocol family netid with the local
857 * rpcbind daemon via an rpcbind v4 SET request.
859 * No netconfig infrastructure is available in the kernel, so
860 * we map IP_ protocol numbers to netids by hand.
862 * Returns zero on success; a negative errno value is returned
863 * if any error occurs.
865 static int __svc_rpcb_register6(struct net *net, const u32 program,
867 const unsigned short protocol,
868 const unsigned short port)
870 const struct sockaddr_in6 sin6 = {
871 .sin6_family = AF_INET6,
872 .sin6_addr = IN6ADDR_ANY_INIT,
873 .sin6_port = htons(port),
880 netid = RPCBIND_NETID_UDP6;
883 netid = RPCBIND_NETID_TCP6;
889 error = rpcb_v4_register(net, program, version,
890 (const struct sockaddr *)&sin6, netid);
893 * User space didn't support rpcbind version 4, so we won't
894 * use a PF_INET6 listener.
896 if (error == -EPROTONOSUPPORT)
897 error = -EAFNOSUPPORT;
901 #endif /* IS_ENABLED(CONFIG_IPV6) */
904 * Register a kernel RPC service via rpcbind version 4.
906 * Returns zero on success; a negative errno value is returned
907 * if any error occurs.
909 static int __svc_register(struct net *net, const char *progname,
910 const u32 program, const u32 version,
912 const unsigned short protocol,
913 const unsigned short port)
915 int error = -EAFNOSUPPORT;
919 error = __svc_rpcb_register4(net, program, version,
922 #if IS_ENABLED(CONFIG_IPV6)
924 error = __svc_rpcb_register6(net, program, version,
930 printk(KERN_WARNING "svc: failed to register %sv%u RPC "
931 "service (errno %d).\n", progname, version, -error);
936 * svc_register - register an RPC service with the local portmapper
937 * @serv: svc_serv struct for the service to register
938 * @net: net namespace for the service to register
939 * @family: protocol family of service's listener socket
940 * @proto: transport protocol number to advertise
941 * @port: port to advertise
943 * Service is registered for any address in the passed-in protocol family
945 int svc_register(const struct svc_serv *serv, struct net *net,
946 const int family, const unsigned short proto,
947 const unsigned short port)
949 struct svc_program *progp;
953 WARN_ON_ONCE(proto == 0 && port == 0);
954 if (proto == 0 && port == 0)
957 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
958 for (i = 0; i < progp->pg_nvers; i++) {
959 if (progp->pg_vers[i] == NULL)
962 dprintk("svc: svc_register(%sv%d, %s, %u, %u)%s\n",
965 proto == IPPROTO_UDP? "udp" : "tcp",
968 progp->pg_vers[i]->vs_hidden?
969 " (but not telling portmap)" : "");
971 if (progp->pg_vers[i]->vs_hidden)
974 error = __svc_register(net, progp->pg_name, progp->pg_prog,
975 i, family, proto, port);
985 * If user space is running rpcbind, it should take the v4 UNSET
986 * and clear everything for this [program, version]. If user space
987 * is running portmap, it will reject the v4 UNSET, but won't have
988 * any "inet6" entries anyway. So a PMAP_UNSET should be sufficient
989 * in this case to clear all existing entries for [program, version].
991 static void __svc_unregister(struct net *net, const u32 program, const u32 version,
992 const char *progname)
996 error = rpcb_v4_register(net, program, version, NULL, "");
999 * User space didn't support rpcbind v4, so retry this
1000 * request with the legacy rpcbind v2 protocol.
1002 if (error == -EPROTONOSUPPORT)
1003 error = rpcb_register(net, program, version, 0, 0);
1005 dprintk("svc: %s(%sv%u), error %d\n",
1006 __func__, progname, version, error);
1010 * All netids, bind addresses and ports registered for [program, version]
1011 * are removed from the local rpcbind database (if the service is not
1012 * hidden) to make way for a new instance of the service.
1014 * The result of unregistration is reported via dprintk for those who want
1015 * verification of the result, but is otherwise not important.
1017 static void svc_unregister(const struct svc_serv *serv, struct net *net)
1019 struct svc_program *progp;
1020 unsigned long flags;
1023 clear_thread_flag(TIF_SIGPENDING);
1025 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
1026 for (i = 0; i < progp->pg_nvers; i++) {
1027 if (progp->pg_vers[i] == NULL)
1029 if (progp->pg_vers[i]->vs_hidden)
1032 dprintk("svc: attempting to unregister %sv%u\n",
1034 __svc_unregister(net, progp->pg_prog, i, progp->pg_name);
1038 spin_lock_irqsave(¤t->sighand->siglock, flags);
1039 recalc_sigpending();
1040 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
1044 * Printk the given error with the address of the client that caused it.
1046 static __printf(2, 3)
1047 void svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
1049 struct va_format vaf;
1051 char buf[RPC_MAX_ADDRBUFLEN];
1053 va_start(args, fmt);
1058 net_warn_ratelimited("svc: %s: %pV",
1059 svc_print_addr(rqstp, buf, sizeof(buf)), &vaf);
1065 * Common routine for processing the RPC request.
1068 svc_process_common(struct svc_rqst *rqstp, struct kvec *argv, struct kvec *resv)
1070 struct svc_program *progp;
1071 struct svc_version *versp = NULL; /* compiler food */
1072 struct svc_procedure *procp = NULL;
1073 struct svc_serv *serv = rqstp->rq_server;
1076 u32 prog, vers, proc;
1077 __be32 auth_stat, rpc_stat;
1079 __be32 *reply_statp;
1081 rpc_stat = rpc_success;
1083 if (argv->iov_len < 6*4)
1086 /* Will be turned off only in gss privacy case: */
1087 rqstp->rq_splice_ok = 1;
1088 /* Will be turned off only when NFSv4 Sessions are used */
1089 rqstp->rq_usedeferral = 1;
1090 rqstp->rq_dropme = false;
1092 /* Setup reply header */
1093 rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
1095 svc_putu32(resv, rqstp->rq_xid);
1097 vers = svc_getnl(argv);
1099 /* First words of reply: */
1100 svc_putnl(resv, 1); /* REPLY */
1102 if (vers != 2) /* RPC version number */
1105 /* Save position in case we later decide to reject: */
1106 reply_statp = resv->iov_base + resv->iov_len;
1108 svc_putnl(resv, 0); /* ACCEPT */
1110 rqstp->rq_prog = prog = svc_getnl(argv); /* program number */
1111 rqstp->rq_vers = vers = svc_getnl(argv); /* version number */
1112 rqstp->rq_proc = proc = svc_getnl(argv); /* procedure number */
1114 progp = serv->sv_program;
1116 for (progp = serv->sv_program; progp; progp = progp->pg_next)
1117 if (prog == progp->pg_prog)
1121 * Decode auth data, and add verifier to reply buffer.
1122 * We do this before anything else in order to get a decent
1125 auth_res = svc_authenticate(rqstp, &auth_stat);
1126 /* Also give the program a chance to reject this call: */
1127 if (auth_res == SVC_OK && progp) {
1128 auth_stat = rpc_autherr_badcred;
1129 auth_res = progp->pg_authenticate(rqstp);
1137 rpc_stat = rpc_system_err;
1142 if (test_bit(XPT_TEMP, &rqstp->rq_xprt->xpt_flags))
1143 svc_close_xprt(rqstp->rq_xprt);
1153 if (vers >= progp->pg_nvers ||
1154 !(versp = progp->pg_vers[vers]))
1157 procp = versp->vs_proc + proc;
1158 if (proc >= versp->vs_nproc || !procp->pc_func)
1160 rqstp->rq_procinfo = procp;
1162 /* Syntactic check complete */
1163 serv->sv_stats->rpccnt++;
1165 /* Build the reply header. */
1166 statp = resv->iov_base +resv->iov_len;
1167 svc_putnl(resv, RPC_SUCCESS);
1169 /* Bump per-procedure stats counter */
1172 /* Initialize storage for argp and resp */
1173 memset(rqstp->rq_argp, 0, procp->pc_argsize);
1174 memset(rqstp->rq_resp, 0, procp->pc_ressize);
1176 /* un-reserve some of the out-queue now that we have a
1177 * better idea of reply size
1179 if (procp->pc_xdrressize)
1180 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
1182 /* Call the function that processes the request. */
1183 if (!versp->vs_dispatch) {
1184 /* Decode arguments */
1185 xdr = procp->pc_decode;
1186 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
1189 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
1192 if (rqstp->rq_dropme) {
1193 if (procp->pc_release)
1194 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1197 if (*statp == rpc_success &&
1198 (xdr = procp->pc_encode) &&
1199 !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
1200 dprintk("svc: failed to encode reply\n");
1201 /* serv->sv_stats->rpcsystemerr++; */
1202 *statp = rpc_system_err;
1205 dprintk("svc: calling dispatcher\n");
1206 if (!versp->vs_dispatch(rqstp, statp)) {
1207 /* Release reply info */
1208 if (procp->pc_release)
1209 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1214 /* Check RPC status result */
1215 if (*statp != rpc_success)
1216 resv->iov_len = ((void*)statp) - resv->iov_base + 4;
1218 /* Release reply info */
1219 if (procp->pc_release)
1220 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1222 if (procp->pc_encode == NULL)
1226 if (svc_authorise(rqstp))
1228 return 1; /* Caller can now send it */
1231 svc_authorise(rqstp); /* doesn't hurt to call this twice */
1232 dprintk("svc: svc_process dropit\n");
1236 svc_printk(rqstp, "short len %Zd, dropping request\n",
1239 goto dropit; /* drop request */
1242 serv->sv_stats->rpcbadfmt++;
1243 svc_putnl(resv, 1); /* REJECT */
1244 svc_putnl(resv, 0); /* RPC_MISMATCH */
1245 svc_putnl(resv, 2); /* Only RPCv2 supported */
1250 dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1251 serv->sv_stats->rpcbadauth++;
1252 /* Restore write pointer to location of accept status: */
1253 xdr_ressize_check(rqstp, reply_statp);
1254 svc_putnl(resv, 1); /* REJECT */
1255 svc_putnl(resv, 1); /* AUTH_ERROR */
1256 svc_putnl(resv, ntohl(auth_stat)); /* status */
1260 dprintk("svc: unknown program %d\n", prog);
1261 serv->sv_stats->rpcbadfmt++;
1262 svc_putnl(resv, RPC_PROG_UNAVAIL);
1266 svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
1267 vers, prog, progp->pg_name);
1269 serv->sv_stats->rpcbadfmt++;
1270 svc_putnl(resv, RPC_PROG_MISMATCH);
1271 svc_putnl(resv, progp->pg_lovers);
1272 svc_putnl(resv, progp->pg_hivers);
1276 svc_printk(rqstp, "unknown procedure (%d)\n", proc);
1278 serv->sv_stats->rpcbadfmt++;
1279 svc_putnl(resv, RPC_PROC_UNAVAIL);
1283 svc_printk(rqstp, "failed to decode args\n");
1285 rpc_stat = rpc_garbage_args;
1287 serv->sv_stats->rpcbadfmt++;
1288 svc_putnl(resv, ntohl(rpc_stat));
1291 EXPORT_SYMBOL_GPL(svc_process);
1294 * Process the RPC request.
1297 svc_process(struct svc_rqst *rqstp)
1299 struct kvec *argv = &rqstp->rq_arg.head[0];
1300 struct kvec *resv = &rqstp->rq_res.head[0];
1301 struct svc_serv *serv = rqstp->rq_server;
1305 * Setup response xdr_buf.
1306 * Initially it has just one page
1308 rqstp->rq_resused = 1;
1309 resv->iov_base = page_address(rqstp->rq_respages[0]);
1311 rqstp->rq_res.pages = rqstp->rq_respages + 1;
1312 rqstp->rq_res.len = 0;
1313 rqstp->rq_res.page_base = 0;
1314 rqstp->rq_res.page_len = 0;
1315 rqstp->rq_res.buflen = PAGE_SIZE;
1316 rqstp->rq_res.tail[0].iov_base = NULL;
1317 rqstp->rq_res.tail[0].iov_len = 0;
1319 rqstp->rq_xid = svc_getu32(argv);
1321 dir = svc_getnl(argv);
1323 /* direction != CALL */
1324 svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
1325 serv->sv_stats->rpcbadfmt++;
1330 /* Returns 1 for send, 0 for drop */
1331 if (svc_process_common(rqstp, argv, resv))
1332 return svc_send(rqstp);
1339 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1341 * Process a backchannel RPC request that arrived over an existing
1342 * outbound connection
1345 bc_svc_process(struct svc_serv *serv, struct rpc_rqst *req,
1346 struct svc_rqst *rqstp)
1348 struct kvec *argv = &rqstp->rq_arg.head[0];
1349 struct kvec *resv = &rqstp->rq_res.head[0];
1351 /* Build the svc_rqst used by the common processing routine */
1352 rqstp->rq_xprt = serv->sv_bc_xprt;
1353 rqstp->rq_xid = req->rq_xid;
1354 rqstp->rq_prot = req->rq_xprt->prot;
1355 rqstp->rq_server = serv;
1357 rqstp->rq_addrlen = sizeof(req->rq_xprt->addr);
1358 memcpy(&rqstp->rq_addr, &req->rq_xprt->addr, rqstp->rq_addrlen);
1359 memcpy(&rqstp->rq_arg, &req->rq_rcv_buf, sizeof(rqstp->rq_arg));
1360 memcpy(&rqstp->rq_res, &req->rq_snd_buf, sizeof(rqstp->rq_res));
1362 /* reset result send buffer "put" position */
1365 if (rqstp->rq_prot != IPPROTO_TCP) {
1366 printk(KERN_ERR "No support for Non-TCP transports!\n");
1371 * Skip the next two words because they've already been
1372 * processed in the trasport
1374 svc_getu32(argv); /* XID */
1375 svc_getnl(argv); /* CALLDIR */
1377 /* Returns 1 for send, 0 for drop */
1378 if (svc_process_common(rqstp, argv, resv)) {
1379 memcpy(&req->rq_snd_buf, &rqstp->rq_res,
1380 sizeof(req->rq_snd_buf));
1381 return bc_send(req);
1384 xprt_free_bc_request(req);
1388 EXPORT_SYMBOL_GPL(bc_svc_process);
1389 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1392 * Return (transport-specific) limit on the rpc payload.
1394 u32 svc_max_payload(const struct svc_rqst *rqstp)
1396 u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
1398 if (rqstp->rq_server->sv_max_payload < max)
1399 max = rqstp->rq_server->sv_max_payload;
1402 EXPORT_SYMBOL_GPL(svc_max_payload);