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>
24 #include <linux/sunrpc/types.h>
25 #include <linux/sunrpc/xdr.h>
26 #include <linux/sunrpc/stats.h>
27 #include <linux/sunrpc/svcsock.h>
28 #include <linux/sunrpc/clnt.h>
29 #include <linux/sunrpc/bc_xprt.h>
31 #define RPCDBG_FACILITY RPCDBG_SVCDSP
33 static void svc_unregister(const struct svc_serv *serv);
35 #define svc_serv_is_pooled(serv) ((serv)->sv_function)
38 * Mode for mapping cpus to pools.
41 SVC_POOL_AUTO = -1, /* choose one of the others */
42 SVC_POOL_GLOBAL, /* no mapping, just a single global pool
43 * (legacy & UP mode) */
44 SVC_POOL_PERCPU, /* one pool per cpu */
45 SVC_POOL_PERNODE /* one pool per numa node */
47 #define SVC_POOL_DEFAULT SVC_POOL_GLOBAL
50 * Structure for mapping cpus to pools and vice versa.
51 * Setup once during sunrpc initialisation.
53 static struct svc_pool_map {
54 int count; /* How many svc_servs use us */
55 int mode; /* Note: int not enum to avoid
56 * warnings about "enumeration value
57 * not handled in switch" */
59 unsigned int *pool_to; /* maps pool id to cpu or node */
60 unsigned int *to_pool; /* maps cpu or node to pool id */
63 .mode = SVC_POOL_DEFAULT
65 static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
68 param_set_pool_mode(const char *val, struct kernel_param *kp)
70 int *ip = (int *)kp->arg;
71 struct svc_pool_map *m = &svc_pool_map;
74 mutex_lock(&svc_pool_map_mutex);
81 if (!strncmp(val, "auto", 4))
83 else if (!strncmp(val, "global", 6))
84 *ip = SVC_POOL_GLOBAL;
85 else if (!strncmp(val, "percpu", 6))
86 *ip = SVC_POOL_PERCPU;
87 else if (!strncmp(val, "pernode", 7))
88 *ip = SVC_POOL_PERNODE;
93 mutex_unlock(&svc_pool_map_mutex);
98 param_get_pool_mode(char *buf, struct kernel_param *kp)
100 int *ip = (int *)kp->arg;
105 return strlcpy(buf, "auto", 20);
106 case SVC_POOL_GLOBAL:
107 return strlcpy(buf, "global", 20);
108 case SVC_POOL_PERCPU:
109 return strlcpy(buf, "percpu", 20);
110 case SVC_POOL_PERNODE:
111 return strlcpy(buf, "pernode", 20);
113 return sprintf(buf, "%d", *ip);
117 module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
118 &svc_pool_map.mode, 0644);
121 * Detect best pool mapping mode heuristically,
122 * according to the machine's topology.
125 svc_pool_map_choose_mode(void)
129 if (nr_online_nodes > 1) {
131 * Actually have multiple NUMA nodes,
132 * so split pools on NUMA node boundaries
134 return SVC_POOL_PERNODE;
137 node = first_online_node;
138 if (nr_cpus_node(node) > 2) {
140 * Non-trivial SMP, or CONFIG_NUMA on
141 * non-NUMA hardware, e.g. with a generic
142 * x86_64 kernel on Xeons. In this case we
143 * want to divide the pools on cpu boundaries.
145 return SVC_POOL_PERCPU;
148 /* default: one global pool */
149 return SVC_POOL_GLOBAL;
153 * Allocate the to_pool[] and pool_to[] arrays.
154 * Returns 0 on success or an errno.
157 svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools)
159 m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
162 m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
176 * Initialise the pool map for SVC_POOL_PERCPU mode.
177 * Returns number of pools or <0 on error.
180 svc_pool_map_init_percpu(struct svc_pool_map *m)
182 unsigned int maxpools = nr_cpu_ids;
183 unsigned int pidx = 0;
187 err = svc_pool_map_alloc_arrays(m, maxpools);
191 for_each_online_cpu(cpu) {
192 BUG_ON(pidx > maxpools);
193 m->to_pool[cpu] = pidx;
194 m->pool_to[pidx] = cpu;
197 /* cpus brought online later all get mapped to pool0, sorry */
204 * Initialise the pool map for SVC_POOL_PERNODE mode.
205 * Returns number of pools or <0 on error.
208 svc_pool_map_init_pernode(struct svc_pool_map *m)
210 unsigned int maxpools = nr_node_ids;
211 unsigned int pidx = 0;
215 err = svc_pool_map_alloc_arrays(m, maxpools);
219 for_each_node_with_cpus(node) {
220 /* some architectures (e.g. SN2) have cpuless nodes */
221 BUG_ON(pidx > maxpools);
222 m->to_pool[node] = pidx;
223 m->pool_to[pidx] = node;
226 /* nodes brought online later all get mapped to pool0, sorry */
233 * Add a reference to the global map of cpus to pools (and
234 * vice versa). Initialise the map if we're the first user.
235 * Returns the number of pools.
238 svc_pool_map_get(void)
240 struct svc_pool_map *m = &svc_pool_map;
243 mutex_lock(&svc_pool_map_mutex);
246 mutex_unlock(&svc_pool_map_mutex);
250 if (m->mode == SVC_POOL_AUTO)
251 m->mode = svc_pool_map_choose_mode();
254 case SVC_POOL_PERCPU:
255 npools = svc_pool_map_init_percpu(m);
257 case SVC_POOL_PERNODE:
258 npools = svc_pool_map_init_pernode(m);
263 /* default, or memory allocation failure */
265 m->mode = SVC_POOL_GLOBAL;
269 mutex_unlock(&svc_pool_map_mutex);
275 * Drop a reference to the global map of cpus to pools.
276 * When the last reference is dropped, the map data is
277 * freed; this allows the sysadmin to change the pool
278 * mode using the pool_mode module option without
279 * rebooting or re-loading sunrpc.ko.
282 svc_pool_map_put(void)
284 struct svc_pool_map *m = &svc_pool_map;
286 mutex_lock(&svc_pool_map_mutex);
289 m->mode = SVC_POOL_DEFAULT;
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 BUG_ON(m->count == 0);
330 case SVC_POOL_PERCPU:
332 set_cpus_allowed_ptr(task, cpumask_of(node));
335 case SVC_POOL_PERNODE:
337 set_cpus_allowed_ptr(task, cpumask_of_node(node));
344 * Use the mapping mode to choose a pool for a given CPU.
345 * Used when enqueueing an incoming RPC. Always returns
346 * a non-NULL pool pointer.
349 svc_pool_for_cpu(struct svc_serv *serv, int cpu)
351 struct svc_pool_map *m = &svc_pool_map;
352 unsigned int pidx = 0;
355 * An uninitialised map happens in a pure client when
356 * lockd is brought up, so silently treat it the
357 * same as SVC_POOL_GLOBAL.
359 if (svc_serv_is_pooled(serv)) {
361 case SVC_POOL_PERCPU:
362 pidx = m->to_pool[cpu];
364 case SVC_POOL_PERNODE:
365 pidx = m->to_pool[cpu_to_node(cpu)];
369 return &serv->sv_pools[pidx % serv->sv_nrpools];
372 static int svc_rpcb_setup(struct svc_serv *serv)
376 err = rpcb_create_local();
380 /* Remove any stale portmap registrations */
381 svc_unregister(serv);
385 void svc_rpcb_cleanup(struct svc_serv *serv)
387 svc_unregister(serv);
390 EXPORT_SYMBOL_GPL(svc_rpcb_cleanup);
392 static int svc_uses_rpcbind(struct svc_serv *serv)
394 struct svc_program *progp;
397 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
398 for (i = 0; i < progp->pg_nvers; i++) {
399 if (progp->pg_vers[i] == NULL)
401 if (progp->pg_vers[i]->vs_hidden == 0)
410 * Create an RPC service
412 static struct svc_serv *
413 __svc_create(struct svc_program *prog, unsigned int bufsize, int npools,
414 void (*shutdown)(struct svc_serv *serv))
416 struct svc_serv *serv;
418 unsigned int xdrsize;
421 if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
423 serv->sv_name = prog->pg_name;
424 serv->sv_program = prog;
425 serv->sv_nrthreads = 1;
426 serv->sv_stats = prog->pg_stats;
427 if (bufsize > RPCSVC_MAXPAYLOAD)
428 bufsize = RPCSVC_MAXPAYLOAD;
429 serv->sv_max_payload = bufsize? bufsize : 4096;
430 serv->sv_max_mesg = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE);
431 serv->sv_shutdown = shutdown;
434 prog->pg_lovers = prog->pg_nvers-1;
435 for (vers=0; vers<prog->pg_nvers ; vers++)
436 if (prog->pg_vers[vers]) {
437 prog->pg_hivers = vers;
438 if (prog->pg_lovers > vers)
439 prog->pg_lovers = vers;
440 if (prog->pg_vers[vers]->vs_xdrsize > xdrsize)
441 xdrsize = prog->pg_vers[vers]->vs_xdrsize;
443 prog = prog->pg_next;
445 serv->sv_xdrsize = xdrsize;
446 INIT_LIST_HEAD(&serv->sv_tempsocks);
447 INIT_LIST_HEAD(&serv->sv_permsocks);
448 init_timer(&serv->sv_temptimer);
449 spin_lock_init(&serv->sv_lock);
451 serv->sv_nrpools = npools;
453 kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
455 if (!serv->sv_pools) {
460 for (i = 0; i < serv->sv_nrpools; i++) {
461 struct svc_pool *pool = &serv->sv_pools[i];
463 dprintk("svc: initialising pool %u for %s\n",
467 INIT_LIST_HEAD(&pool->sp_threads);
468 INIT_LIST_HEAD(&pool->sp_sockets);
469 INIT_LIST_HEAD(&pool->sp_all_threads);
470 spin_lock_init(&pool->sp_lock);
473 if (svc_uses_rpcbind(serv)) {
474 if (svc_rpcb_setup(serv) < 0) {
475 kfree(serv->sv_pools);
479 if (!serv->sv_shutdown)
480 serv->sv_shutdown = svc_rpcb_cleanup;
487 svc_create(struct svc_program *prog, unsigned int bufsize,
488 void (*shutdown)(struct svc_serv *serv))
490 return __svc_create(prog, bufsize, /*npools*/1, shutdown);
492 EXPORT_SYMBOL_GPL(svc_create);
495 svc_create_pooled(struct svc_program *prog, unsigned int bufsize,
496 void (*shutdown)(struct svc_serv *serv),
497 svc_thread_fn func, struct module *mod)
499 struct svc_serv *serv;
500 unsigned int npools = svc_pool_map_get();
502 serv = __svc_create(prog, bufsize, npools, shutdown);
505 serv->sv_function = func;
506 serv->sv_module = mod;
511 EXPORT_SYMBOL_GPL(svc_create_pooled);
514 * Destroy an RPC service. Should be called with appropriate locking to
515 * protect the sv_nrthreads, sv_permsocks and sv_tempsocks.
518 svc_destroy(struct svc_serv *serv)
520 dprintk("svc: svc_destroy(%s, %d)\n",
521 serv->sv_program->pg_name,
524 if (serv->sv_nrthreads) {
525 if (--(serv->sv_nrthreads) != 0) {
526 svc_sock_update_bufs(serv);
530 printk("svc_destroy: no threads for serv=%p!\n", serv);
532 del_timer_sync(&serv->sv_temptimer);
536 if (serv->sv_shutdown)
537 serv->sv_shutdown(serv);
539 cache_clean_deferred(serv);
541 if (svc_serv_is_pooled(serv))
544 kfree(serv->sv_pools);
547 EXPORT_SYMBOL_GPL(svc_destroy);
550 * Allocate an RPC server's buffer space.
551 * We allocate pages and place them in rq_argpages.
554 svc_init_buffer(struct svc_rqst *rqstp, unsigned int size, int node)
556 unsigned int pages, arghi;
558 /* bc_xprt uses fore channel allocated buffers */
559 if (svc_is_backchannel(rqstp))
562 pages = size / PAGE_SIZE + 1; /* extra page as we hold both request and reply.
563 * We assume one is at most one page
566 BUG_ON(pages > RPCSVC_MAXPAGES);
568 struct page *p = alloc_pages_node(node, GFP_KERNEL, 0);
571 rqstp->rq_pages[arghi++] = p;
578 * Release an RPC server buffer
581 svc_release_buffer(struct svc_rqst *rqstp)
585 for (i = 0; i < ARRAY_SIZE(rqstp->rq_pages); i++)
586 if (rqstp->rq_pages[i])
587 put_page(rqstp->rq_pages[i]);
591 svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool, int node)
593 struct svc_rqst *rqstp;
595 rqstp = kzalloc_node(sizeof(*rqstp), GFP_KERNEL, node);
599 init_waitqueue_head(&rqstp->rq_wait);
601 serv->sv_nrthreads++;
602 spin_lock_bh(&pool->sp_lock);
603 pool->sp_nrthreads++;
604 list_add(&rqstp->rq_all, &pool->sp_all_threads);
605 spin_unlock_bh(&pool->sp_lock);
606 rqstp->rq_server = serv;
607 rqstp->rq_pool = pool;
609 rqstp->rq_argp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
613 rqstp->rq_resp = kmalloc_node(serv->sv_xdrsize, GFP_KERNEL, node);
617 if (!svc_init_buffer(rqstp, serv->sv_max_mesg, node))
622 svc_exit_thread(rqstp);
624 return ERR_PTR(-ENOMEM);
626 EXPORT_SYMBOL_GPL(svc_prepare_thread);
629 * Choose a pool in which to create a new thread, for svc_set_num_threads
631 static inline struct svc_pool *
632 choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
637 return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
641 * Choose a thread to kill, for svc_set_num_threads
643 static inline struct task_struct *
644 choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
647 struct task_struct *task = NULL;
650 spin_lock_bh(&pool->sp_lock);
652 /* choose a pool in round-robin fashion */
653 for (i = 0; i < serv->sv_nrpools; i++) {
654 pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
655 spin_lock_bh(&pool->sp_lock);
656 if (!list_empty(&pool->sp_all_threads))
658 spin_unlock_bh(&pool->sp_lock);
664 if (!list_empty(&pool->sp_all_threads)) {
665 struct svc_rqst *rqstp;
668 * Remove from the pool->sp_all_threads list
669 * so we don't try to kill it again.
671 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
672 list_del_init(&rqstp->rq_all);
673 task = rqstp->rq_task;
675 spin_unlock_bh(&pool->sp_lock);
681 * Create or destroy enough new threads to make the number
682 * of threads the given number. If `pool' is non-NULL, applies
683 * only to threads in that pool, otherwise round-robins between
684 * all pools. Must be called with a svc_get() reference and
685 * the BKL or another lock to protect access to svc_serv fields.
687 * Destroying threads relies on the service threads filling in
688 * rqstp->rq_task, which only the nfs ones do. Assumes the serv
689 * has been created using svc_create_pooled().
691 * Based on code that used to be in nfsd_svc() but tweaked
695 svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
697 struct svc_rqst *rqstp;
698 struct task_struct *task;
699 struct svc_pool *chosen_pool;
701 unsigned int state = serv->sv_nrthreads-1;
705 /* The -1 assumes caller has done a svc_get() */
706 nrservs -= (serv->sv_nrthreads-1);
708 spin_lock_bh(&pool->sp_lock);
709 nrservs -= pool->sp_nrthreads;
710 spin_unlock_bh(&pool->sp_lock);
713 /* create new threads */
714 while (nrservs > 0) {
716 chosen_pool = choose_pool(serv, pool, &state);
718 node = svc_pool_map_get_node(chosen_pool->sp_id);
719 rqstp = svc_prepare_thread(serv, chosen_pool, node);
721 error = PTR_ERR(rqstp);
725 __module_get(serv->sv_module);
726 task = kthread_create_on_node(serv->sv_function, rqstp,
727 node, serv->sv_name);
729 error = PTR_ERR(task);
730 module_put(serv->sv_module);
731 svc_exit_thread(rqstp);
735 rqstp->rq_task = task;
736 if (serv->sv_nrpools > 1)
737 svc_pool_map_set_cpumask(task, chosen_pool->sp_id);
739 svc_sock_update_bufs(serv);
740 wake_up_process(task);
742 /* destroy old threads */
743 while (nrservs < 0 &&
744 (task = choose_victim(serv, pool, &state)) != NULL) {
745 send_sig(SIGINT, task, 1);
751 EXPORT_SYMBOL_GPL(svc_set_num_threads);
754 * Called from a server thread as it's exiting. Caller must hold the BKL or
755 * the "service mutex", whichever is appropriate for the service.
758 svc_exit_thread(struct svc_rqst *rqstp)
760 struct svc_serv *serv = rqstp->rq_server;
761 struct svc_pool *pool = rqstp->rq_pool;
763 svc_release_buffer(rqstp);
764 kfree(rqstp->rq_resp);
765 kfree(rqstp->rq_argp);
766 kfree(rqstp->rq_auth_data);
768 spin_lock_bh(&pool->sp_lock);
769 pool->sp_nrthreads--;
770 list_del(&rqstp->rq_all);
771 spin_unlock_bh(&pool->sp_lock);
775 /* Release the server */
779 EXPORT_SYMBOL_GPL(svc_exit_thread);
782 * Register an "inet" protocol family netid with the local
783 * rpcbind daemon via an rpcbind v4 SET request.
785 * No netconfig infrastructure is available in the kernel, so
786 * we map IP_ protocol numbers to netids by hand.
788 * Returns zero on success; a negative errno value is returned
789 * if any error occurs.
791 static int __svc_rpcb_register4(const u32 program, const u32 version,
792 const unsigned short protocol,
793 const unsigned short port)
795 const struct sockaddr_in sin = {
796 .sin_family = AF_INET,
797 .sin_addr.s_addr = htonl(INADDR_ANY),
798 .sin_port = htons(port),
805 netid = RPCBIND_NETID_UDP;
808 netid = RPCBIND_NETID_TCP;
814 error = rpcb_v4_register(program, version,
815 (const struct sockaddr *)&sin, netid);
818 * User space didn't support rpcbind v4, so retry this
819 * registration request with the legacy rpcbind v2 protocol.
821 if (error == -EPROTONOSUPPORT)
822 error = rpcb_register(program, version, protocol, port);
827 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
829 * Register an "inet6" protocol family netid with the local
830 * rpcbind daemon via an rpcbind v4 SET request.
832 * No netconfig infrastructure is available in the kernel, so
833 * we map IP_ protocol numbers to netids by hand.
835 * Returns zero on success; a negative errno value is returned
836 * if any error occurs.
838 static int __svc_rpcb_register6(const u32 program, const u32 version,
839 const unsigned short protocol,
840 const unsigned short port)
842 const struct sockaddr_in6 sin6 = {
843 .sin6_family = AF_INET6,
844 .sin6_addr = IN6ADDR_ANY_INIT,
845 .sin6_port = htons(port),
852 netid = RPCBIND_NETID_UDP6;
855 netid = RPCBIND_NETID_TCP6;
861 error = rpcb_v4_register(program, version,
862 (const struct sockaddr *)&sin6, netid);
865 * User space didn't support rpcbind version 4, so we won't
866 * use a PF_INET6 listener.
868 if (error == -EPROTONOSUPPORT)
869 error = -EAFNOSUPPORT;
873 #endif /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
876 * Register a kernel RPC service via rpcbind version 4.
878 * Returns zero on success; a negative errno value is returned
879 * if any error occurs.
881 static int __svc_register(const char *progname,
882 const u32 program, const u32 version,
884 const unsigned short protocol,
885 const unsigned short port)
887 int error = -EAFNOSUPPORT;
891 error = __svc_rpcb_register4(program, version,
894 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
896 error = __svc_rpcb_register6(program, version,
898 #endif /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
902 printk(KERN_WARNING "svc: failed to register %sv%u RPC "
903 "service (errno %d).\n", progname, version, -error);
908 * svc_register - register an RPC service with the local portmapper
909 * @serv: svc_serv struct for the service to register
910 * @family: protocol family of service's listener socket
911 * @proto: transport protocol number to advertise
912 * @port: port to advertise
914 * Service is registered for any address in the passed-in protocol family
916 int svc_register(const struct svc_serv *serv, const int family,
917 const unsigned short proto, const unsigned short port)
919 struct svc_program *progp;
923 BUG_ON(proto == 0 && port == 0);
925 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
926 for (i = 0; i < progp->pg_nvers; i++) {
927 if (progp->pg_vers[i] == NULL)
930 dprintk("svc: svc_register(%sv%d, %s, %u, %u)%s\n",
933 proto == IPPROTO_UDP? "udp" : "tcp",
936 progp->pg_vers[i]->vs_hidden?
937 " (but not telling portmap)" : "");
939 if (progp->pg_vers[i]->vs_hidden)
942 error = __svc_register(progp->pg_name, progp->pg_prog,
943 i, family, proto, port);
953 * If user space is running rpcbind, it should take the v4 UNSET
954 * and clear everything for this [program, version]. If user space
955 * is running portmap, it will reject the v4 UNSET, but won't have
956 * any "inet6" entries anyway. So a PMAP_UNSET should be sufficient
957 * in this case to clear all existing entries for [program, version].
959 static void __svc_unregister(const u32 program, const u32 version,
960 const char *progname)
964 error = rpcb_v4_register(program, version, NULL, "");
967 * User space didn't support rpcbind v4, so retry this
968 * request with the legacy rpcbind v2 protocol.
970 if (error == -EPROTONOSUPPORT)
971 error = rpcb_register(program, version, 0, 0);
973 dprintk("svc: %s(%sv%u), error %d\n",
974 __func__, progname, version, error);
978 * All netids, bind addresses and ports registered for [program, version]
979 * are removed from the local rpcbind database (if the service is not
980 * hidden) to make way for a new instance of the service.
982 * The result of unregistration is reported via dprintk for those who want
983 * verification of the result, but is otherwise not important.
985 static void svc_unregister(const struct svc_serv *serv)
987 struct svc_program *progp;
991 clear_thread_flag(TIF_SIGPENDING);
993 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
994 for (i = 0; i < progp->pg_nvers; i++) {
995 if (progp->pg_vers[i] == NULL)
997 if (progp->pg_vers[i]->vs_hidden)
1000 dprintk("svc: attempting to unregister %sv%u\n",
1002 __svc_unregister(progp->pg_prog, i, progp->pg_name);
1006 spin_lock_irqsave(¤t->sighand->siglock, flags);
1007 recalc_sigpending();
1008 spin_unlock_irqrestore(¤t->sighand->siglock, flags);
1012 * Printk the given error with the address of the client that caused it.
1014 static __printf(2, 3)
1015 int svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
1019 char buf[RPC_MAX_ADDRBUFLEN];
1021 if (!net_ratelimit())
1024 printk(KERN_WARNING "svc: %s: ",
1025 svc_print_addr(rqstp, buf, sizeof(buf)));
1027 va_start(args, fmt);
1028 r = vprintk(fmt, args);
1035 * Common routine for processing the RPC request.
1038 svc_process_common(struct svc_rqst *rqstp, struct kvec *argv, struct kvec *resv)
1040 struct svc_program *progp;
1041 struct svc_version *versp = NULL; /* compiler food */
1042 struct svc_procedure *procp = NULL;
1043 struct svc_serv *serv = rqstp->rq_server;
1046 u32 prog, vers, proc;
1047 __be32 auth_stat, rpc_stat;
1049 __be32 *reply_statp;
1051 rpc_stat = rpc_success;
1053 if (argv->iov_len < 6*4)
1056 /* Will be turned off only in gss privacy case: */
1057 rqstp->rq_splice_ok = 1;
1058 /* Will be turned off only when NFSv4 Sessions are used */
1059 rqstp->rq_usedeferral = 1;
1060 rqstp->rq_dropme = false;
1062 /* Setup reply header */
1063 rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
1065 svc_putu32(resv, rqstp->rq_xid);
1067 vers = svc_getnl(argv);
1069 /* First words of reply: */
1070 svc_putnl(resv, 1); /* REPLY */
1072 if (vers != 2) /* RPC version number */
1075 /* Save position in case we later decide to reject: */
1076 reply_statp = resv->iov_base + resv->iov_len;
1078 svc_putnl(resv, 0); /* ACCEPT */
1080 rqstp->rq_prog = prog = svc_getnl(argv); /* program number */
1081 rqstp->rq_vers = vers = svc_getnl(argv); /* version number */
1082 rqstp->rq_proc = proc = svc_getnl(argv); /* procedure number */
1084 progp = serv->sv_program;
1086 for (progp = serv->sv_program; progp; progp = progp->pg_next)
1087 if (prog == progp->pg_prog)
1091 * Decode auth data, and add verifier to reply buffer.
1092 * We do this before anything else in order to get a decent
1095 auth_res = svc_authenticate(rqstp, &auth_stat);
1096 /* Also give the program a chance to reject this call: */
1097 if (auth_res == SVC_OK && progp) {
1098 auth_stat = rpc_autherr_badcred;
1099 auth_res = progp->pg_authenticate(rqstp);
1107 rpc_stat = rpc_system_err;
1112 if (test_bit(XPT_TEMP, &rqstp->rq_xprt->xpt_flags))
1113 svc_close_xprt(rqstp->rq_xprt);
1123 if (vers >= progp->pg_nvers ||
1124 !(versp = progp->pg_vers[vers]))
1127 procp = versp->vs_proc + proc;
1128 if (proc >= versp->vs_nproc || !procp->pc_func)
1130 rqstp->rq_procinfo = procp;
1132 /* Syntactic check complete */
1133 serv->sv_stats->rpccnt++;
1135 /* Build the reply header. */
1136 statp = resv->iov_base +resv->iov_len;
1137 svc_putnl(resv, RPC_SUCCESS);
1139 /* Bump per-procedure stats counter */
1142 /* Initialize storage for argp and resp */
1143 memset(rqstp->rq_argp, 0, procp->pc_argsize);
1144 memset(rqstp->rq_resp, 0, procp->pc_ressize);
1146 /* un-reserve some of the out-queue now that we have a
1147 * better idea of reply size
1149 if (procp->pc_xdrressize)
1150 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
1152 /* Call the function that processes the request. */
1153 if (!versp->vs_dispatch) {
1154 /* Decode arguments */
1155 xdr = procp->pc_decode;
1156 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
1159 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
1162 if (rqstp->rq_dropme) {
1163 if (procp->pc_release)
1164 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1167 if (*statp == rpc_success &&
1168 (xdr = procp->pc_encode) &&
1169 !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
1170 dprintk("svc: failed to encode reply\n");
1171 /* serv->sv_stats->rpcsystemerr++; */
1172 *statp = rpc_system_err;
1175 dprintk("svc: calling dispatcher\n");
1176 if (!versp->vs_dispatch(rqstp, statp)) {
1177 /* Release reply info */
1178 if (procp->pc_release)
1179 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1184 /* Check RPC status result */
1185 if (*statp != rpc_success)
1186 resv->iov_len = ((void*)statp) - resv->iov_base + 4;
1188 /* Release reply info */
1189 if (procp->pc_release)
1190 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1192 if (procp->pc_encode == NULL)
1196 if (svc_authorise(rqstp))
1198 return 1; /* Caller can now send it */
1201 svc_authorise(rqstp); /* doesn't hurt to call this twice */
1202 dprintk("svc: svc_process dropit\n");
1206 svc_printk(rqstp, "short len %Zd, dropping request\n",
1209 goto dropit; /* drop request */
1212 serv->sv_stats->rpcbadfmt++;
1213 svc_putnl(resv, 1); /* REJECT */
1214 svc_putnl(resv, 0); /* RPC_MISMATCH */
1215 svc_putnl(resv, 2); /* Only RPCv2 supported */
1220 dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1221 serv->sv_stats->rpcbadauth++;
1222 /* Restore write pointer to location of accept status: */
1223 xdr_ressize_check(rqstp, reply_statp);
1224 svc_putnl(resv, 1); /* REJECT */
1225 svc_putnl(resv, 1); /* AUTH_ERROR */
1226 svc_putnl(resv, ntohl(auth_stat)); /* status */
1230 dprintk("svc: unknown program %d\n", prog);
1231 serv->sv_stats->rpcbadfmt++;
1232 svc_putnl(resv, RPC_PROG_UNAVAIL);
1236 svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
1237 vers, prog, progp->pg_name);
1239 serv->sv_stats->rpcbadfmt++;
1240 svc_putnl(resv, RPC_PROG_MISMATCH);
1241 svc_putnl(resv, progp->pg_lovers);
1242 svc_putnl(resv, progp->pg_hivers);
1246 svc_printk(rqstp, "unknown procedure (%d)\n", proc);
1248 serv->sv_stats->rpcbadfmt++;
1249 svc_putnl(resv, RPC_PROC_UNAVAIL);
1253 svc_printk(rqstp, "failed to decode args\n");
1255 rpc_stat = rpc_garbage_args;
1257 serv->sv_stats->rpcbadfmt++;
1258 svc_putnl(resv, ntohl(rpc_stat));
1261 EXPORT_SYMBOL_GPL(svc_process);
1264 * Process the RPC request.
1267 svc_process(struct svc_rqst *rqstp)
1269 struct kvec *argv = &rqstp->rq_arg.head[0];
1270 struct kvec *resv = &rqstp->rq_res.head[0];
1271 struct svc_serv *serv = rqstp->rq_server;
1275 * Setup response xdr_buf.
1276 * Initially it has just one page
1278 rqstp->rq_resused = 1;
1279 resv->iov_base = page_address(rqstp->rq_respages[0]);
1281 rqstp->rq_res.pages = rqstp->rq_respages + 1;
1282 rqstp->rq_res.len = 0;
1283 rqstp->rq_res.page_base = 0;
1284 rqstp->rq_res.page_len = 0;
1285 rqstp->rq_res.buflen = PAGE_SIZE;
1286 rqstp->rq_res.tail[0].iov_base = NULL;
1287 rqstp->rq_res.tail[0].iov_len = 0;
1289 rqstp->rq_xid = svc_getu32(argv);
1291 dir = svc_getnl(argv);
1293 /* direction != CALL */
1294 svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
1295 serv->sv_stats->rpcbadfmt++;
1300 /* Returns 1 for send, 0 for drop */
1301 if (svc_process_common(rqstp, argv, resv))
1302 return svc_send(rqstp);
1309 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
1311 * Process a backchannel RPC request that arrived over an existing
1312 * outbound connection
1315 bc_svc_process(struct svc_serv *serv, struct rpc_rqst *req,
1316 struct svc_rqst *rqstp)
1318 struct kvec *argv = &rqstp->rq_arg.head[0];
1319 struct kvec *resv = &rqstp->rq_res.head[0];
1321 /* Build the svc_rqst used by the common processing routine */
1322 rqstp->rq_xprt = serv->sv_bc_xprt;
1323 rqstp->rq_xid = req->rq_xid;
1324 rqstp->rq_prot = req->rq_xprt->prot;
1325 rqstp->rq_server = serv;
1327 rqstp->rq_addrlen = sizeof(req->rq_xprt->addr);
1328 memcpy(&rqstp->rq_addr, &req->rq_xprt->addr, rqstp->rq_addrlen);
1329 memcpy(&rqstp->rq_arg, &req->rq_rcv_buf, sizeof(rqstp->rq_arg));
1330 memcpy(&rqstp->rq_res, &req->rq_snd_buf, sizeof(rqstp->rq_res));
1332 /* reset result send buffer "put" position */
1335 if (rqstp->rq_prot != IPPROTO_TCP) {
1336 printk(KERN_ERR "No support for Non-TCP transports!\n");
1341 * Skip the next two words because they've already been
1342 * processed in the trasport
1344 svc_getu32(argv); /* XID */
1345 svc_getnl(argv); /* CALLDIR */
1347 /* Returns 1 for send, 0 for drop */
1348 if (svc_process_common(rqstp, argv, resv)) {
1349 memcpy(&req->rq_snd_buf, &rqstp->rq_res,
1350 sizeof(req->rq_snd_buf));
1351 return bc_send(req);
1353 /* Nothing to do to drop request */
1357 EXPORT_SYMBOL_GPL(bc_svc_process);
1358 #endif /* CONFIG_SUNRPC_BACKCHANNEL */
1361 * Return (transport-specific) limit on the rpc payload.
1363 u32 svc_max_payload(const struct svc_rqst *rqstp)
1365 u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
1367 if (rqstp->rq_server->sv_max_payload < max)
1368 max = rqstp->rq_server->sv_max_payload;
1371 EXPORT_SYMBOL_GPL(svc_max_payload);