blob: 6a69a1131fb77eb8014f77f404e26389976a3445 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/net/sunrpc/svc.c
3 *
4 * High-level RPC service routines
5 *
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
Greg Banksbfd24162006-10-02 02:18:01 -07007 *
8 * Multiple threads pools and NUMAisation
9 * Copyright (c) 2006 Silicon Graphics, Inc.
10 * by Greg Banks <gnb@melbourne.sgi.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 */
12
13#include <linux/linkage.h>
14#include <linux/sched.h>
15#include <linux/errno.h>
16#include <linux/net.h>
17#include <linux/in.h>
18#include <linux/mm.h>
Greg Banksa7455442006-10-02 02:17:59 -070019#include <linux/interrupt.h>
20#include <linux/module.h>
Jeff Layton9867d762008-06-10 08:40:38 -040021#include <linux/kthread.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090022#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
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>
Ricardo Labiaga4d6bbb62009-04-01 09:23:07 -040029#include <linux/sunrpc/bc_xprt.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31#define RPCDBG_FACILITY RPCDBG_SVCDSP
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Chuck Lever7252d572008-08-18 19:34:08 -040033static void svc_unregister(const struct svc_serv *serv);
34
Greg Banks42a7fc42007-03-06 01:42:23 -080035#define svc_serv_is_pooled(serv) ((serv)->sv_function)
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037/*
Greg Banksbfd24162006-10-02 02:18:01 -070038 * Mode for mapping cpus to pools.
39 */
40enum {
Greg Banks42a7fc42007-03-06 01:42:23 -080041 SVC_POOL_AUTO = -1, /* choose one of the others */
Greg Banksbfd24162006-10-02 02:18:01 -070042 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 */
46};
Greg Banks42a7fc42007-03-06 01:42:23 -080047#define SVC_POOL_DEFAULT SVC_POOL_GLOBAL
Greg Banksbfd24162006-10-02 02:18:01 -070048
49/*
50 * Structure for mapping cpus to pools and vice versa.
51 * Setup once during sunrpc initialisation.
52 */
53static struct svc_pool_map {
Greg Banks42a7fc42007-03-06 01:42:23 -080054 int count; /* How many svc_servs use us */
Greg Banksbfd24162006-10-02 02:18:01 -070055 int mode; /* Note: int not enum to avoid
56 * warnings about "enumeration value
57 * not handled in switch" */
58 unsigned int npools;
59 unsigned int *pool_to; /* maps pool id to cpu or node */
60 unsigned int *to_pool; /* maps cpu or node to pool id */
61} svc_pool_map = {
Greg Banks42a7fc42007-03-06 01:42:23 -080062 .count = 0,
63 .mode = SVC_POOL_DEFAULT
Greg Banksbfd24162006-10-02 02:18:01 -070064};
Greg Banks42a7fc42007-03-06 01:42:23 -080065static DEFINE_MUTEX(svc_pool_map_mutex);/* protects svc_pool_map.count only */
Greg Banksbfd24162006-10-02 02:18:01 -070066
Greg Banks42a7fc42007-03-06 01:42:23 -080067static int
68param_set_pool_mode(const char *val, struct kernel_param *kp)
69{
70 int *ip = (int *)kp->arg;
71 struct svc_pool_map *m = &svc_pool_map;
72 int err;
73
74 mutex_lock(&svc_pool_map_mutex);
75
76 err = -EBUSY;
77 if (m->count)
78 goto out;
79
80 err = 0;
81 if (!strncmp(val, "auto", 4))
82 *ip = SVC_POOL_AUTO;
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;
89 else
90 err = -EINVAL;
91
92out:
93 mutex_unlock(&svc_pool_map_mutex);
94 return err;
95}
96
97static int
98param_get_pool_mode(char *buf, struct kernel_param *kp)
99{
100 int *ip = (int *)kp->arg;
101
102 switch (*ip)
103 {
104 case SVC_POOL_AUTO:
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);
112 default:
113 return sprintf(buf, "%d", *ip);
114 }
115}
116
117module_param_call(pool_mode, param_set_pool_mode, param_get_pool_mode,
118 &svc_pool_map.mode, 0644);
Greg Banksbfd24162006-10-02 02:18:01 -0700119
120/*
121 * Detect best pool mapping mode heuristically,
122 * according to the machine's topology.
123 */
124static int
125svc_pool_map_choose_mode(void)
126{
127 unsigned int node;
128
Christoph Lameter62bc62a2009-06-16 15:32:15 -0700129 if (nr_online_nodes > 1) {
Greg Banksbfd24162006-10-02 02:18:01 -0700130 /*
131 * Actually have multiple NUMA nodes,
132 * so split pools on NUMA node boundaries
133 */
134 return SVC_POOL_PERNODE;
135 }
136
H Hartley Sweeten72c33682010-03-05 13:42:43 -0800137 node = first_online_node;
Greg Banksbfd24162006-10-02 02:18:01 -0700138 if (nr_cpus_node(node) > 2) {
139 /*
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.
144 */
145 return SVC_POOL_PERCPU;
146 }
147
148 /* default: one global pool */
149 return SVC_POOL_GLOBAL;
150}
151
152/*
153 * Allocate the to_pool[] and pool_to[] arrays.
154 * Returns 0 on success or an errno.
155 */
156static int
157svc_pool_map_alloc_arrays(struct svc_pool_map *m, unsigned int maxpools)
158{
159 m->to_pool = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
160 if (!m->to_pool)
161 goto fail;
162 m->pool_to = kcalloc(maxpools, sizeof(unsigned int), GFP_KERNEL);
163 if (!m->pool_to)
164 goto fail_free;
165
166 return 0;
167
168fail_free:
169 kfree(m->to_pool);
170fail:
171 return -ENOMEM;
172}
173
174/*
175 * Initialise the pool map for SVC_POOL_PERCPU mode.
176 * Returns number of pools or <0 on error.
177 */
178static int
179svc_pool_map_init_percpu(struct svc_pool_map *m)
180{
Christoph Lameter53b8a312007-02-20 13:57:51 -0800181 unsigned int maxpools = nr_cpu_ids;
Greg Banksbfd24162006-10-02 02:18:01 -0700182 unsigned int pidx = 0;
183 unsigned int cpu;
184 int err;
185
186 err = svc_pool_map_alloc_arrays(m, maxpools);
187 if (err)
188 return err;
189
190 for_each_online_cpu(cpu) {
191 BUG_ON(pidx > maxpools);
192 m->to_pool[cpu] = pidx;
193 m->pool_to[pidx] = cpu;
194 pidx++;
195 }
196 /* cpus brought online later all get mapped to pool0, sorry */
197
198 return pidx;
199};
200
201
202/*
203 * Initialise the pool map for SVC_POOL_PERNODE mode.
204 * Returns number of pools or <0 on error.
205 */
206static int
207svc_pool_map_init_pernode(struct svc_pool_map *m)
208{
Christoph Lameter74c7aa82007-02-20 13:57:51 -0800209 unsigned int maxpools = nr_node_ids;
Greg Banksbfd24162006-10-02 02:18:01 -0700210 unsigned int pidx = 0;
211 unsigned int node;
212 int err;
213
214 err = svc_pool_map_alloc_arrays(m, maxpools);
215 if (err)
216 return err;
217
218 for_each_node_with_cpus(node) {
219 /* some architectures (e.g. SN2) have cpuless nodes */
220 BUG_ON(pidx > maxpools);
221 m->to_pool[node] = pidx;
222 m->pool_to[pidx] = node;
223 pidx++;
224 }
225 /* nodes brought online later all get mapped to pool0, sorry */
226
227 return pidx;
228}
229
230
231/*
Greg Banks42a7fc42007-03-06 01:42:23 -0800232 * Add a reference to the global map of cpus to pools (and
233 * vice versa). Initialise the map if we're the first user.
234 * Returns the number of pools.
Greg Banksbfd24162006-10-02 02:18:01 -0700235 */
236static unsigned int
Greg Banks42a7fc42007-03-06 01:42:23 -0800237svc_pool_map_get(void)
Greg Banksbfd24162006-10-02 02:18:01 -0700238{
239 struct svc_pool_map *m = &svc_pool_map;
240 int npools = -1;
241
Greg Banks42a7fc42007-03-06 01:42:23 -0800242 mutex_lock(&svc_pool_map_mutex);
Greg Banksbfd24162006-10-02 02:18:01 -0700243
Greg Banks42a7fc42007-03-06 01:42:23 -0800244 if (m->count++) {
245 mutex_unlock(&svc_pool_map_mutex);
246 return m->npools;
247 }
248
249 if (m->mode == SVC_POOL_AUTO)
250 m->mode = svc_pool_map_choose_mode();
Greg Banksbfd24162006-10-02 02:18:01 -0700251
252 switch (m->mode) {
253 case SVC_POOL_PERCPU:
254 npools = svc_pool_map_init_percpu(m);
255 break;
256 case SVC_POOL_PERNODE:
257 npools = svc_pool_map_init_pernode(m);
258 break;
259 }
260
261 if (npools < 0) {
262 /* default, or memory allocation failure */
263 npools = 1;
264 m->mode = SVC_POOL_GLOBAL;
265 }
266 m->npools = npools;
267
Greg Banks42a7fc42007-03-06 01:42:23 -0800268 mutex_unlock(&svc_pool_map_mutex);
Greg Banksbfd24162006-10-02 02:18:01 -0700269 return m->npools;
270}
271
Greg Banks42a7fc42007-03-06 01:42:23 -0800272
273/*
274 * Drop a reference to the global map of cpus to pools.
275 * When the last reference is dropped, the map data is
276 * freed; this allows the sysadmin to change the pool
277 * mode using the pool_mode module option without
278 * rebooting or re-loading sunrpc.ko.
279 */
280static void
281svc_pool_map_put(void)
282{
283 struct svc_pool_map *m = &svc_pool_map;
284
285 mutex_lock(&svc_pool_map_mutex);
286
287 if (!--m->count) {
288 m->mode = SVC_POOL_DEFAULT;
289 kfree(m->to_pool);
290 kfree(m->pool_to);
291 m->npools = 0;
292 }
293
294 mutex_unlock(&svc_pool_map_mutex);
295}
296
297
Greg Banksbfd24162006-10-02 02:18:01 -0700298/*
Jeff Layton9867d762008-06-10 08:40:38 -0400299 * Set the given thread's cpus_allowed mask so that it
Greg Banksbfd24162006-10-02 02:18:01 -0700300 * will only run on cpus in the given pool.
Greg Banksbfd24162006-10-02 02:18:01 -0700301 */
Jeff Layton9867d762008-06-10 08:40:38 -0400302static inline void
303svc_pool_map_set_cpumask(struct task_struct *task, unsigned int pidx)
Greg Banksbfd24162006-10-02 02:18:01 -0700304{
305 struct svc_pool_map *m = &svc_pool_map;
Jeff Layton9867d762008-06-10 08:40:38 -0400306 unsigned int node = m->pool_to[pidx];
Greg Banksbfd24162006-10-02 02:18:01 -0700307
308 /*
309 * The caller checks for sv_nrpools > 1, which
Greg Banks42a7fc42007-03-06 01:42:23 -0800310 * implies that we've been initialized.
Greg Banksbfd24162006-10-02 02:18:01 -0700311 */
Greg Banks42a7fc42007-03-06 01:42:23 -0800312 BUG_ON(m->count == 0);
Greg Banksbfd24162006-10-02 02:18:01 -0700313
Jeff Layton9867d762008-06-10 08:40:38 -0400314 switch (m->mode) {
Greg Banksbfd24162006-10-02 02:18:01 -0700315 case SVC_POOL_PERCPU:
Mike Travisc5f59f02008-04-04 18:11:10 -0700316 {
Rusty Russellaa85ea52009-03-30 22:05:15 -0600317 set_cpus_allowed_ptr(task, cpumask_of(node));
Jeff Layton9867d762008-06-10 08:40:38 -0400318 break;
Mike Travisc5f59f02008-04-04 18:11:10 -0700319 }
Greg Banksbfd24162006-10-02 02:18:01 -0700320 case SVC_POOL_PERNODE:
Mike Travisc5f59f02008-04-04 18:11:10 -0700321 {
Rusty Russella70f7302009-03-13 14:49:46 +1030322 set_cpus_allowed_ptr(task, cpumask_of_node(node));
Jeff Layton9867d762008-06-10 08:40:38 -0400323 break;
Greg Banksbfd24162006-10-02 02:18:01 -0700324 }
Mike Travisc5f59f02008-04-04 18:11:10 -0700325 }
Greg Banksbfd24162006-10-02 02:18:01 -0700326}
327
328/*
329 * Use the mapping mode to choose a pool for a given CPU.
330 * Used when enqueueing an incoming RPC. Always returns
331 * a non-NULL pool pointer.
332 */
333struct svc_pool *
334svc_pool_for_cpu(struct svc_serv *serv, int cpu)
335{
336 struct svc_pool_map *m = &svc_pool_map;
337 unsigned int pidx = 0;
338
339 /*
Greg Banks42a7fc42007-03-06 01:42:23 -0800340 * An uninitialised map happens in a pure client when
Greg Banksbfd24162006-10-02 02:18:01 -0700341 * lockd is brought up, so silently treat it the
342 * same as SVC_POOL_GLOBAL.
343 */
Greg Banks42a7fc42007-03-06 01:42:23 -0800344 if (svc_serv_is_pooled(serv)) {
345 switch (m->mode) {
346 case SVC_POOL_PERCPU:
347 pidx = m->to_pool[cpu];
348 break;
349 case SVC_POOL_PERNODE:
350 pidx = m->to_pool[cpu_to_node(cpu)];
351 break;
352 }
Greg Banksbfd24162006-10-02 02:18:01 -0700353 }
354 return &serv->sv_pools[pidx % serv->sv_nrpools];
355}
356
357
358/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 * Create an RPC service
360 */
Greg Banksa7455442006-10-02 02:17:59 -0700361static struct svc_serv *
362__svc_create(struct svc_program *prog, unsigned int bufsize, int npools,
Chuck Lever49a90722009-03-18 20:46:29 -0400363 void (*shutdown)(struct svc_serv *serv))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364{
365 struct svc_serv *serv;
Chuck Leverea339d42007-10-26 13:32:56 -0400366 unsigned int vers;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 unsigned int xdrsize;
Greg Banks3262c812006-10-02 02:17:58 -0700368 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700370 if (!(serv = kzalloc(sizeof(*serv), GFP_KERNEL)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 return NULL;
Andreas Gruenbacher9ba02632005-06-22 17:16:24 +0000372 serv->sv_name = prog->pg_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 serv->sv_program = prog;
374 serv->sv_nrthreads = 1;
375 serv->sv_stats = prog->pg_stats;
NeilBrownc6b0a9f2006-10-06 00:44:05 -0700376 if (bufsize > RPCSVC_MAXPAYLOAD)
377 bufsize = RPCSVC_MAXPAYLOAD;
378 serv->sv_max_payload = bufsize? bufsize : 4096;
379 serv->sv_max_mesg = roundup(serv->sv_max_payload + PAGE_SIZE, PAGE_SIZE);
NeilBrownbc591cc2006-10-02 02:17:44 -0700380 serv->sv_shutdown = shutdown;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 xdrsize = 0;
Andreas Gruenbacher9ba02632005-06-22 17:16:24 +0000382 while (prog) {
383 prog->pg_lovers = prog->pg_nvers-1;
384 for (vers=0; vers<prog->pg_nvers ; vers++)
385 if (prog->pg_vers[vers]) {
386 prog->pg_hivers = vers;
387 if (prog->pg_lovers > vers)
388 prog->pg_lovers = vers;
389 if (prog->pg_vers[vers]->vs_xdrsize > xdrsize)
390 xdrsize = prog->pg_vers[vers]->vs_xdrsize;
391 }
392 prog = prog->pg_next;
393 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 serv->sv_xdrsize = xdrsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 INIT_LIST_HEAD(&serv->sv_tempsocks);
396 INIT_LIST_HEAD(&serv->sv_permsocks);
Greg Banks36bdfc82006-10-02 02:17:54 -0700397 init_timer(&serv->sv_temptimer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 spin_lock_init(&serv->sv_lock);
399
Greg Banksa7455442006-10-02 02:17:59 -0700400 serv->sv_nrpools = npools;
Greg Banks3262c812006-10-02 02:17:58 -0700401 serv->sv_pools =
Robert P. J. Daycd861282006-12-13 00:34:52 -0800402 kcalloc(serv->sv_nrpools, sizeof(struct svc_pool),
Greg Banks3262c812006-10-02 02:17:58 -0700403 GFP_KERNEL);
404 if (!serv->sv_pools) {
405 kfree(serv);
406 return NULL;
407 }
408
409 for (i = 0; i < serv->sv_nrpools; i++) {
410 struct svc_pool *pool = &serv->sv_pools[i];
411
Chuck Lever46121cf2007-01-31 12:14:08 -0500412 dprintk("svc: initialising pool %u for %s\n",
Greg Banks3262c812006-10-02 02:17:58 -0700413 i, serv->sv_name);
414
415 pool->sp_id = i;
416 INIT_LIST_HEAD(&pool->sp_threads);
417 INIT_LIST_HEAD(&pool->sp_sockets);
Greg Banksa7455442006-10-02 02:17:59 -0700418 INIT_LIST_HEAD(&pool->sp_all_threads);
Greg Banks3262c812006-10-02 02:17:58 -0700419 spin_lock_init(&pool->sp_lock);
420 }
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 /* Remove any stale portmap registrations */
Chuck Lever7252d572008-08-18 19:34:08 -0400423 svc_unregister(serv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
425 return serv;
426}
427
Greg Banksa7455442006-10-02 02:17:59 -0700428struct svc_serv *
429svc_create(struct svc_program *prog, unsigned int bufsize,
Chuck Lever49a90722009-03-18 20:46:29 -0400430 void (*shutdown)(struct svc_serv *serv))
Greg Banksa7455442006-10-02 02:17:59 -0700431{
Chuck Lever49a90722009-03-18 20:46:29 -0400432 return __svc_create(prog, bufsize, /*npools*/1, shutdown);
Greg Banksa7455442006-10-02 02:17:59 -0700433}
Trond Myklebust24c37672008-12-23 16:30:12 -0500434EXPORT_SYMBOL_GPL(svc_create);
Greg Banksa7455442006-10-02 02:17:59 -0700435
436struct svc_serv *
437svc_create_pooled(struct svc_program *prog, unsigned int bufsize,
Chuck Lever49a90722009-03-18 20:46:29 -0400438 void (*shutdown)(struct svc_serv *serv),
Jeff Laytona75c5d02008-06-10 08:40:39 -0400439 svc_thread_fn func, struct module *mod)
Greg Banksa7455442006-10-02 02:17:59 -0700440{
441 struct svc_serv *serv;
Greg Banks42a7fc42007-03-06 01:42:23 -0800442 unsigned int npools = svc_pool_map_get();
Greg Banksa7455442006-10-02 02:17:59 -0700443
Chuck Lever49a90722009-03-18 20:46:29 -0400444 serv = __svc_create(prog, bufsize, npools, shutdown);
Greg Banksa7455442006-10-02 02:17:59 -0700445
446 if (serv != NULL) {
447 serv->sv_function = func;
Greg Banksa7455442006-10-02 02:17:59 -0700448 serv->sv_module = mod;
449 }
450
451 return serv;
452}
Trond Myklebust24c37672008-12-23 16:30:12 -0500453EXPORT_SYMBOL_GPL(svc_create_pooled);
Greg Banksa7455442006-10-02 02:17:59 -0700454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455/*
Neil Brownbedbdd82008-06-10 08:40:35 -0400456 * Destroy an RPC service. Should be called with appropriate locking to
457 * protect the sv_nrthreads, sv_permsocks and sv_tempsocks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 */
459void
460svc_destroy(struct svc_serv *serv)
461{
Chuck Lever46121cf2007-01-31 12:14:08 -0500462 dprintk("svc: svc_destroy(%s, %d)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 serv->sv_program->pg_name,
464 serv->sv_nrthreads);
465
466 if (serv->sv_nrthreads) {
467 if (--(serv->sv_nrthreads) != 0) {
468 svc_sock_update_bufs(serv);
469 return;
470 }
471 } else
472 printk("svc_destroy: no threads for serv=%p!\n", serv);
473
Greg Banks36bdfc82006-10-02 02:17:54 -0700474 del_timer_sync(&serv->sv_temptimer);
475
Tom Tucker7a182082007-12-30 21:07:53 -0600476 svc_close_all(&serv->sv_tempsocks);
NeilBrowncda1fd42007-03-06 01:42:22 -0800477
NeilBrownbc591cc2006-10-02 02:17:44 -0700478 if (serv->sv_shutdown)
479 serv->sv_shutdown(serv);
480
Tom Tucker7a182082007-12-30 21:07:53 -0600481 svc_close_all(&serv->sv_permsocks);
NeilBrowncda1fd42007-03-06 01:42:22 -0800482
483 BUG_ON(!list_empty(&serv->sv_permsocks));
484 BUG_ON(!list_empty(&serv->sv_tempsocks));
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 cache_clean_deferred(serv);
487
Greg Banks42a7fc42007-03-06 01:42:23 -0800488 if (svc_serv_is_pooled(serv))
489 svc_pool_map_put();
490
Chuck Lever7252d572008-08-18 19:34:08 -0400491 svc_unregister(serv);
Greg Banks3262c812006-10-02 02:17:58 -0700492 kfree(serv->sv_pools);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 kfree(serv);
494}
Trond Myklebust24c37672008-12-23 16:30:12 -0500495EXPORT_SYMBOL_GPL(svc_destroy);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497/*
498 * Allocate an RPC server's buffer space.
499 * We allocate pages and place them in rq_argpages.
500 */
501static int
502svc_init_buffer(struct svc_rqst *rqstp, unsigned int size)
503{
Chuck Lever0dc220f2008-04-14 12:27:52 -0400504 unsigned int pages, arghi;
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800505
Andy Adamsonba176862010-01-26 21:24:04 -0500506 /* bc_xprt uses fore channel allocated buffers */
507 if (svc_is_backchannel(rqstp))
508 return 1;
509
NeilBrownc6b0a9f2006-10-06 00:44:05 -0700510 pages = size / PAGE_SIZE + 1; /* extra page as we hold both request and reply.
511 * We assume one is at most one page
512 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 arghi = 0;
Kris Katterjohn09a62662006-01-08 22:24:28 -0800514 BUG_ON(pages > RPCSVC_MAXPAGES);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 while (pages) {
516 struct page *p = alloc_page(GFP_KERNEL);
517 if (!p)
518 break;
NeilBrown44524352006-10-04 02:15:46 -0700519 rqstp->rq_pages[arghi++] = p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 pages--;
521 }
Chuck Lever0dc220f2008-04-14 12:27:52 -0400522 return pages == 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523}
524
525/*
526 * Release an RPC server buffer
527 */
528static void
529svc_release_buffer(struct svc_rqst *rqstp)
530{
Chuck Lever50c8bb12008-04-14 12:27:45 -0400531 unsigned int i;
532
533 for (i = 0; i < ARRAY_SIZE(rqstp->rq_pages); i++)
NeilBrown44524352006-10-04 02:15:46 -0700534 if (rqstp->rq_pages[i])
535 put_page(rqstp->rq_pages[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536}
537
Jeff Layton0113ab32008-01-29 10:30:54 -0500538struct svc_rqst *
539svc_prepare_thread(struct svc_serv *serv, struct svc_pool *pool)
540{
541 struct svc_rqst *rqstp;
542
543 rqstp = kzalloc(sizeof(*rqstp), GFP_KERNEL);
544 if (!rqstp)
545 goto out_enomem;
546
547 init_waitqueue_head(&rqstp->rq_wait);
548
549 serv->sv_nrthreads++;
550 spin_lock_bh(&pool->sp_lock);
551 pool->sp_nrthreads++;
552 list_add(&rqstp->rq_all, &pool->sp_all_threads);
553 spin_unlock_bh(&pool->sp_lock);
554 rqstp->rq_server = serv;
555 rqstp->rq_pool = pool;
556
557 rqstp->rq_argp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
558 if (!rqstp->rq_argp)
559 goto out_thread;
560
561 rqstp->rq_resp = kmalloc(serv->sv_xdrsize, GFP_KERNEL);
562 if (!rqstp->rq_resp)
563 goto out_thread;
564
565 if (!svc_init_buffer(rqstp, serv->sv_max_mesg))
566 goto out_thread;
567
568 return rqstp;
569out_thread:
570 svc_exit_thread(rqstp);
571out_enomem:
572 return ERR_PTR(-ENOMEM);
573}
Trond Myklebust24c37672008-12-23 16:30:12 -0500574EXPORT_SYMBOL_GPL(svc_prepare_thread);
Jeff Layton0113ab32008-01-29 10:30:54 -0500575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576/*
Greg Banksa7455442006-10-02 02:17:59 -0700577 * Choose a pool in which to create a new thread, for svc_set_num_threads
578 */
579static inline struct svc_pool *
580choose_pool(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
581{
582 if (pool != NULL)
583 return pool;
584
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800585 return &serv->sv_pools[(*state)++ % serv->sv_nrpools];
Greg Banksa7455442006-10-02 02:17:59 -0700586}
587
588/*
589 * Choose a thread to kill, for svc_set_num_threads
590 */
591static inline struct task_struct *
592choose_victim(struct svc_serv *serv, struct svc_pool *pool, unsigned int *state)
593{
594 unsigned int i;
595 struct task_struct *task = NULL;
596
597 if (pool != NULL) {
598 spin_lock_bh(&pool->sp_lock);
599 } else {
600 /* choose a pool in round-robin fashion */
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800601 for (i = 0; i < serv->sv_nrpools; i++) {
602 pool = &serv->sv_pools[--(*state) % serv->sv_nrpools];
Greg Banksa7455442006-10-02 02:17:59 -0700603 spin_lock_bh(&pool->sp_lock);
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800604 if (!list_empty(&pool->sp_all_threads))
605 goto found_pool;
Greg Banksa7455442006-10-02 02:17:59 -0700606 spin_unlock_bh(&pool->sp_lock);
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800607 }
Greg Banksa7455442006-10-02 02:17:59 -0700608 return NULL;
609 }
610
611found_pool:
612 if (!list_empty(&pool->sp_all_threads)) {
613 struct svc_rqst *rqstp;
614
615 /*
616 * Remove from the pool->sp_all_threads list
617 * so we don't try to kill it again.
618 */
619 rqstp = list_entry(pool->sp_all_threads.next, struct svc_rqst, rq_all);
620 list_del_init(&rqstp->rq_all);
621 task = rqstp->rq_task;
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800622 }
Greg Banksa7455442006-10-02 02:17:59 -0700623 spin_unlock_bh(&pool->sp_lock);
624
625 return task;
626}
627
628/*
629 * Create or destroy enough new threads to make the number
630 * of threads the given number. If `pool' is non-NULL, applies
631 * only to threads in that pool, otherwise round-robins between
632 * all pools. Must be called with a svc_get() reference and
Neil Brownbedbdd82008-06-10 08:40:35 -0400633 * the BKL or another lock to protect access to svc_serv fields.
Greg Banksa7455442006-10-02 02:17:59 -0700634 *
635 * Destroying threads relies on the service threads filling in
636 * rqstp->rq_task, which only the nfs ones do. Assumes the serv
637 * has been created using svc_create_pooled().
638 *
639 * Based on code that used to be in nfsd_svc() but tweaked
640 * to be pool-aware.
641 */
642int
643svc_set_num_threads(struct svc_serv *serv, struct svc_pool *pool, int nrservs)
644{
Jeff Layton9867d762008-06-10 08:40:38 -0400645 struct svc_rqst *rqstp;
646 struct task_struct *task;
647 struct svc_pool *chosen_pool;
Greg Banksa7455442006-10-02 02:17:59 -0700648 int error = 0;
649 unsigned int state = serv->sv_nrthreads-1;
650
651 if (pool == NULL) {
652 /* The -1 assumes caller has done a svc_get() */
653 nrservs -= (serv->sv_nrthreads-1);
654 } else {
655 spin_lock_bh(&pool->sp_lock);
656 nrservs -= pool->sp_nrthreads;
657 spin_unlock_bh(&pool->sp_lock);
658 }
659
660 /* create new threads */
661 while (nrservs > 0) {
662 nrservs--;
Jeff Layton9867d762008-06-10 08:40:38 -0400663 chosen_pool = choose_pool(serv, pool, &state);
664
665 rqstp = svc_prepare_thread(serv, chosen_pool);
666 if (IS_ERR(rqstp)) {
667 error = PTR_ERR(rqstp);
Greg Banksa7455442006-10-02 02:17:59 -0700668 break;
669 }
Jeff Layton9867d762008-06-10 08:40:38 -0400670
671 __module_get(serv->sv_module);
672 task = kthread_create(serv->sv_function, rqstp, serv->sv_name);
673 if (IS_ERR(task)) {
674 error = PTR_ERR(task);
675 module_put(serv->sv_module);
676 svc_exit_thread(rqstp);
677 break;
678 }
679
680 rqstp->rq_task = task;
681 if (serv->sv_nrpools > 1)
682 svc_pool_map_set_cpumask(task, chosen_pool->sp_id);
683
684 svc_sock_update_bufs(serv);
685 wake_up_process(task);
Greg Banksa7455442006-10-02 02:17:59 -0700686 }
687 /* destroy old threads */
688 while (nrservs < 0 &&
Jeff Layton9867d762008-06-10 08:40:38 -0400689 (task = choose_victim(serv, pool, &state)) != NULL) {
Jeff Laytona75c5d02008-06-10 08:40:39 -0400690 send_sig(SIGINT, task, 1);
Greg Banksa7455442006-10-02 02:17:59 -0700691 nrservs++;
692 }
693
694 return error;
695}
Trond Myklebust24c37672008-12-23 16:30:12 -0500696EXPORT_SYMBOL_GPL(svc_set_num_threads);
Greg Banksa7455442006-10-02 02:17:59 -0700697
698/*
Neil Brownbedbdd82008-06-10 08:40:35 -0400699 * Called from a server thread as it's exiting. Caller must hold the BKL or
700 * the "service mutex", whichever is appropriate for the service.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 */
702void
703svc_exit_thread(struct svc_rqst *rqstp)
704{
705 struct svc_serv *serv = rqstp->rq_server;
Greg Banks3262c812006-10-02 02:17:58 -0700706 struct svc_pool *pool = rqstp->rq_pool;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
708 svc_release_buffer(rqstp);
Jesper Juhla51482b2005-11-08 09:41:34 -0800709 kfree(rqstp->rq_resp);
710 kfree(rqstp->rq_argp);
711 kfree(rqstp->rq_auth_data);
Greg Banks3262c812006-10-02 02:17:58 -0700712
713 spin_lock_bh(&pool->sp_lock);
714 pool->sp_nrthreads--;
Greg Banksa7455442006-10-02 02:17:59 -0700715 list_del(&rqstp->rq_all);
Greg Banks3262c812006-10-02 02:17:58 -0700716 spin_unlock_bh(&pool->sp_lock);
717
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 kfree(rqstp);
719
720 /* Release the server */
721 if (serv)
722 svc_destroy(serv);
723}
Trond Myklebust24c37672008-12-23 16:30:12 -0500724EXPORT_SYMBOL_GPL(svc_exit_thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
726/*
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500727 * Register an "inet" protocol family netid with the local
728 * rpcbind daemon via an rpcbind v4 SET request.
Chuck Levera26cfad2008-08-18 19:34:16 -0400729 *
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500730 * No netconfig infrastructure is available in the kernel, so
731 * we map IP_ protocol numbers to netids by hand.
Chuck Levera26cfad2008-08-18 19:34:16 -0400732 *
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500733 * Returns zero on success; a negative errno value is returned
734 * if any error occurs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 */
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500736static int __svc_rpcb_register4(const u32 program, const u32 version,
737 const unsigned short protocol,
738 const unsigned short port)
Chuck Levera26cfad2008-08-18 19:34:16 -0400739{
Chuck Levercadc0fa2009-03-18 20:47:36 -0400740 const struct sockaddr_in sin = {
Chuck Levera26cfad2008-08-18 19:34:16 -0400741 .sin_family = AF_INET,
742 .sin_addr.s_addr = htonl(INADDR_ANY),
743 .sin_port = htons(port),
744 };
Chuck Levercadc0fa2009-03-18 20:47:36 -0400745 const char *netid;
746 int error;
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500747
748 switch (protocol) {
749 case IPPROTO_UDP:
750 netid = RPCBIND_NETID_UDP;
751 break;
752 case IPPROTO_TCP:
753 netid = RPCBIND_NETID_TCP;
754 break;
755 default:
Chuck Leverba5c35e2009-03-18 20:46:59 -0400756 return -ENOPROTOOPT;
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500757 }
758
Chuck Levercadc0fa2009-03-18 20:47:36 -0400759 error = rpcb_v4_register(program, version,
760 (const struct sockaddr *)&sin, netid);
761
762 /*
763 * User space didn't support rpcbind v4, so retry this
764 * registration request with the legacy rpcbind v2 protocol.
765 */
766 if (error == -EPROTONOSUPPORT)
767 error = rpcb_register(program, version, protocol, port);
768
769 return error;
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500770}
771
Chuck Levercadc0fa2009-03-18 20:47:36 -0400772#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500773/*
774 * Register an "inet6" protocol family netid with the local
775 * rpcbind daemon via an rpcbind v4 SET request.
776 *
777 * No netconfig infrastructure is available in the kernel, so
778 * we map IP_ protocol numbers to netids by hand.
779 *
780 * Returns zero on success; a negative errno value is returned
781 * if any error occurs.
782 */
783static int __svc_rpcb_register6(const u32 program, const u32 version,
784 const unsigned short protocol,
785 const unsigned short port)
786{
Chuck Levercadc0fa2009-03-18 20:47:36 -0400787 const struct sockaddr_in6 sin6 = {
Chuck Levera26cfad2008-08-18 19:34:16 -0400788 .sin6_family = AF_INET6,
789 .sin6_addr = IN6ADDR_ANY_INIT,
790 .sin6_port = htons(port),
791 };
Chuck Levercadc0fa2009-03-18 20:47:36 -0400792 const char *netid;
793 int error;
Chuck Levera26cfad2008-08-18 19:34:16 -0400794
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500795 switch (protocol) {
796 case IPPROTO_UDP:
797 netid = RPCBIND_NETID_UDP6;
798 break;
799 case IPPROTO_TCP:
800 netid = RPCBIND_NETID_TCP6;
801 break;
802 default:
Chuck Leverba5c35e2009-03-18 20:46:59 -0400803 return -ENOPROTOOPT;
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500804 }
805
Chuck Levercadc0fa2009-03-18 20:47:36 -0400806 error = rpcb_v4_register(program, version,
807 (const struct sockaddr *)&sin6, netid);
808
809 /*
810 * User space didn't support rpcbind version 4, so we won't
811 * use a PF_INET6 listener.
812 */
813 if (error == -EPROTONOSUPPORT)
814 error = -EAFNOSUPPORT;
815
816 return error;
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500817}
Chuck Levercadc0fa2009-03-18 20:47:36 -0400818#endif /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500819
820/*
821 * Register a kernel RPC service via rpcbind version 4.
822 *
823 * Returns zero on success; a negative errno value is returned
824 * if any error occurs.
825 */
Chuck Lever363f7242009-03-18 20:47:44 -0400826static int __svc_register(const char *progname,
827 const u32 program, const u32 version,
Chuck Lever4b62e582009-03-18 20:46:06 -0400828 const int family,
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500829 const unsigned short protocol,
830 const unsigned short port)
831{
Chuck Lever363f7242009-03-18 20:47:44 -0400832 int error = -EAFNOSUPPORT;
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500833
Chuck Levera26cfad2008-08-18 19:34:16 -0400834 switch (family) {
Chuck Lever4b62e582009-03-18 20:46:06 -0400835 case PF_INET:
Chuck Lever363f7242009-03-18 20:47:44 -0400836 error = __svc_rpcb_register4(program, version,
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500837 protocol, port);
Chuck Levercadc0fa2009-03-18 20:47:36 -0400838 break;
839#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
Chuck Lever4b62e582009-03-18 20:46:06 -0400840 case PF_INET6:
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500841 error = __svc_rpcb_register6(program, version,
842 protocol, port);
Chuck Levercadc0fa2009-03-18 20:47:36 -0400843#endif /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
Chuck Levera26cfad2008-08-18 19:34:16 -0400844 }
845
Chuck Lever363f7242009-03-18 20:47:44 -0400846 if (error < 0)
847 printk(KERN_WARNING "svc: failed to register %sv%u RPC "
848 "service (errno %d).\n", progname, version, -error);
849 return error;
Chuck Levera26cfad2008-08-18 19:34:16 -0400850}
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500851
Chuck Levera26cfad2008-08-18 19:34:16 -0400852/**
853 * svc_register - register an RPC service with the local portmapper
854 * @serv: svc_serv struct for the service to register
Chuck Lever4b62e582009-03-18 20:46:06 -0400855 * @family: protocol family of service's listener socket
Chuck Levera26cfad2008-08-18 19:34:16 -0400856 * @proto: transport protocol number to advertise
857 * @port: port to advertise
858 *
Chuck Lever4b62e582009-03-18 20:46:06 -0400859 * Service is registered for any address in the passed-in protocol family
Chuck Levera26cfad2008-08-18 19:34:16 -0400860 */
Chuck Lever4b62e582009-03-18 20:46:06 -0400861int svc_register(const struct svc_serv *serv, const int family,
862 const unsigned short proto, const unsigned short port)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863{
864 struct svc_program *progp;
Chuck Leverea339d42007-10-26 13:32:56 -0400865 unsigned int i;
Chuck Lever14aeb212008-08-18 19:34:00 -0400866 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
Chuck Lever7252d572008-08-18 19:34:08 -0400868 BUG_ON(proto == 0 && port == 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Olaf Kirchbc5fea42006-10-04 02:16:05 -0700870 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
871 for (i = 0; i < progp->pg_nvers; i++) {
872 if (progp->pg_vers[i] == NULL)
873 continue;
874
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500875 dprintk("svc: svc_register(%sv%d, %s, %u, %u)%s\n",
Olaf Kirchbc5fea42006-10-04 02:16:05 -0700876 progp->pg_name,
Chuck Lever2c7eb0b2008-09-15 16:27:23 -0500877 i,
Olaf Kirchbc5fea42006-10-04 02:16:05 -0700878 proto == IPPROTO_UDP? "udp" : "tcp",
879 port,
Chuck Lever4b62e582009-03-18 20:46:06 -0400880 family,
Olaf Kirchbc5fea42006-10-04 02:16:05 -0700881 progp->pg_vers[i]->vs_hidden?
882 " (but not telling portmap)" : "");
883
884 if (progp->pg_vers[i]->vs_hidden)
885 continue;
886
Chuck Lever363f7242009-03-18 20:47:44 -0400887 error = __svc_register(progp->pg_name, progp->pg_prog,
888 i, family, proto, port);
Olaf Kirchbc5fea42006-10-04 02:16:05 -0700889 if (error < 0)
890 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 }
892 }
893
Chuck Lever7252d572008-08-18 19:34:08 -0400894 return error;
895}
896
Chuck Leverd5a86202009-03-18 20:47:29 -0400897/*
898 * If user space is running rpcbind, it should take the v4 UNSET
899 * and clear everything for this [program, version]. If user space
900 * is running portmap, it will reject the v4 UNSET, but won't have
901 * any "inet6" entries anyway. So a PMAP_UNSET should be sufficient
902 * in this case to clear all existing entries for [program, version].
903 */
Chuck Leverf6fb3f62008-09-25 11:56:57 -0400904static void __svc_unregister(const u32 program, const u32 version,
905 const char *progname)
906{
907 int error;
908
Chuck Leverd5a86202009-03-18 20:47:29 -0400909 error = rpcb_v4_register(program, version, NULL, "");
910
911 /*
912 * User space didn't support rpcbind v4, so retry this
913 * request with the legacy rpcbind v2 protocol.
914 */
915 if (error == -EPROTONOSUPPORT)
916 error = rpcb_register(program, version, 0, 0);
917
Chuck Leverf6fb3f62008-09-25 11:56:57 -0400918 dprintk("svc: %s(%sv%u), error %d\n",
919 __func__, progname, version, error);
920}
921
Chuck Lever7252d572008-08-18 19:34:08 -0400922/*
Chuck Leverf6fb3f62008-09-25 11:56:57 -0400923 * All netids, bind addresses and ports registered for [program, version]
924 * are removed from the local rpcbind database (if the service is not
925 * hidden) to make way for a new instance of the service.
Chuck Lever7252d572008-08-18 19:34:08 -0400926 *
Chuck Leverf6fb3f62008-09-25 11:56:57 -0400927 * The result of unregistration is reported via dprintk for those who want
928 * verification of the result, but is otherwise not important.
Chuck Lever7252d572008-08-18 19:34:08 -0400929 */
930static void svc_unregister(const struct svc_serv *serv)
931{
932 struct svc_program *progp;
933 unsigned long flags;
934 unsigned int i;
Chuck Lever7252d572008-08-18 19:34:08 -0400935
936 clear_thread_flag(TIF_SIGPENDING);
937
938 for (progp = serv->sv_program; progp; progp = progp->pg_next) {
939 for (i = 0; i < progp->pg_nvers; i++) {
940 if (progp->pg_vers[i] == NULL)
941 continue;
942 if (progp->pg_vers[i]->vs_hidden)
943 continue;
944
Chuck Lever7402ab192011-05-09 15:22:55 -0400945 dprintk("svc: attempting to unregister %sv%u\n",
946 progp->pg_name, i);
Chuck Leverf6fb3f62008-09-25 11:56:57 -0400947 __svc_unregister(progp->pg_prog, i, progp->pg_name);
Chuck Lever7252d572008-08-18 19:34:08 -0400948 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 }
950
Chuck Lever7252d572008-08-18 19:34:08 -0400951 spin_lock_irqsave(&current->sighand->siglock, flags);
952 recalc_sigpending();
953 spin_unlock_irqrestore(&current->sighand->siglock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954}
955
956/*
Dr. David Alan Gilbert354ecbb2007-08-25 16:09:27 +0100957 * Printk the given error with the address of the client that caused it.
958 */
959static int
960__attribute__ ((format (printf, 2, 3)))
961svc_printk(struct svc_rqst *rqstp, const char *fmt, ...)
962{
963 va_list args;
964 int r;
965 char buf[RPC_MAX_ADDRBUFLEN];
966
967 if (!net_ratelimit())
968 return 0;
969
970 printk(KERN_WARNING "svc: %s: ",
971 svc_print_addr(rqstp, buf, sizeof(buf)));
972
973 va_start(args, fmt);
974 r = vprintk(fmt, args);
975 va_end(args);
976
977 return r;
978}
979
980/*
Ricardo Labiaga1cad7ea2009-04-01 09:23:06 -0400981 * Common routine for processing the RPC request.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 */
Ricardo Labiaga1cad7ea2009-04-01 09:23:06 -0400983static int
984svc_process_common(struct svc_rqst *rqstp, struct kvec *argv, struct kvec *resv)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985{
986 struct svc_program *progp;
987 struct svc_version *versp = NULL; /* compiler food */
988 struct svc_procedure *procp = NULL;
NeilBrown6fb2b472006-10-02 02:17:50 -0700989 struct svc_serv *serv = rqstp->rq_server;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 kxdrproc_t xdr;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700991 __be32 *statp;
Ricardo Labiaga1cad7ea2009-04-01 09:23:06 -0400992 u32 prog, vers, proc;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700993 __be32 auth_stat, rpc_stat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 int auth_res;
J.Bruce Fields8f8e05c2006-10-04 02:16:08 -0700995 __be32 *reply_statp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
997 rpc_stat = rpc_success;
998
999 if (argv->iov_len < 6*4)
1000 goto err_short_len;
1001
J. Bruce Fields5c04c462006-06-30 01:56:19 -07001002 /* Will be turned off only in gss privacy case: */
Jens Axboecf8208d2007-06-12 21:22:14 +02001003 rqstp->rq_splice_ok = 1;
Andy Adamson2f425872009-04-03 08:27:32 +03001004 /* Will be turned off only when NFSv4 Sessions are used */
1005 rqstp->rq_usedeferral = 1;
J. Bruce Fields9e701c62011-01-02 21:56:36 -05001006 rqstp->rq_dropme = false;
Tom Tuckere831fe62007-12-30 21:07:29 -06001007
1008 /* Setup reply header */
1009 rqstp->rq_xprt->xpt_ops->xpo_prep_reply_hdr(rqstp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 svc_putu32(resv, rqstp->rq_xid);
1012
Alexey Dobriyan76994312006-09-26 22:28:46 -07001013 vers = svc_getnl(argv);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
1015 /* First words of reply: */
Alexey Dobriyan76994312006-09-26 22:28:46 -07001016 svc_putnl(resv, 1); /* REPLY */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 if (vers != 2) /* RPC version number */
1019 goto err_bad_rpc;
1020
1021 /* Save position in case we later decide to reject: */
J.Bruce Fields8f8e05c2006-10-04 02:16:08 -07001022 reply_statp = resv->iov_base + resv->iov_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023
Alexey Dobriyan76994312006-09-26 22:28:46 -07001024 svc_putnl(resv, 0); /* ACCEPT */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
Alexey Dobriyan76994312006-09-26 22:28:46 -07001026 rqstp->rq_prog = prog = svc_getnl(argv); /* program number */
1027 rqstp->rq_vers = vers = svc_getnl(argv); /* version number */
1028 rqstp->rq_proc = proc = svc_getnl(argv); /* procedure number */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
1030 progp = serv->sv_program;
NeilBrown80d188a2005-11-07 01:00:27 -08001031
1032 for (progp = serv->sv_program; progp; progp = progp->pg_next)
1033 if (prog == progp->pg_prog)
1034 break;
1035
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 /*
1037 * Decode auth data, and add verifier to reply buffer.
1038 * We do this before anything else in order to get a decent
1039 * auth verifier.
1040 */
1041 auth_res = svc_authenticate(rqstp, &auth_stat);
1042 /* Also give the program a chance to reject this call: */
NeilBrown80d188a2005-11-07 01:00:27 -08001043 if (auth_res == SVC_OK && progp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 auth_stat = rpc_autherr_badcred;
1045 auth_res = progp->pg_authenticate(rqstp);
1046 }
1047 switch (auth_res) {
1048 case SVC_OK:
1049 break;
1050 case SVC_GARBAGE:
Harshula Jayasuriyadd352102008-02-20 10:56:56 +11001051 goto err_garbage;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 case SVC_SYSERR:
1053 rpc_stat = rpc_system_err;
1054 goto err_bad;
1055 case SVC_DENIED:
1056 goto err_bad_auth;
NeilBrown1ebede82010-08-12 17:04:07 +10001057 case SVC_CLOSE:
1058 if (test_bit(XPT_TEMP, &rqstp->rq_xprt->xpt_flags))
1059 svc_close_xprt(rqstp->rq_xprt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 case SVC_DROP:
1061 goto dropit;
1062 case SVC_COMPLETE:
1063 goto sendit;
1064 }
NeilBrown80d188a2005-11-07 01:00:27 -08001065
Andreas Gruenbacher9ba02632005-06-22 17:16:24 +00001066 if (progp == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 goto err_bad_prog;
1068
1069 if (vers >= progp->pg_nvers ||
1070 !(versp = progp->pg_vers[vers]))
1071 goto err_bad_vers;
1072
1073 procp = versp->vs_proc + proc;
1074 if (proc >= versp->vs_nproc || !procp->pc_func)
1075 goto err_bad_proc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 rqstp->rq_procinfo = procp;
1077
1078 /* Syntactic check complete */
1079 serv->sv_stats->rpccnt++;
1080
1081 /* Build the reply header. */
1082 statp = resv->iov_base +resv->iov_len;
Alexey Dobriyan76994312006-09-26 22:28:46 -07001083 svc_putnl(resv, RPC_SUCCESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001084
1085 /* Bump per-procedure stats counter */
1086 procp->pc_count++;
1087
1088 /* Initialize storage for argp and resp */
1089 memset(rqstp->rq_argp, 0, procp->pc_argsize);
1090 memset(rqstp->rq_resp, 0, procp->pc_ressize);
1091
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -08001092 /* un-reserve some of the out-queue now that we have a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 * better idea of reply size
1094 */
1095 if (procp->pc_xdrressize)
Jeff Laytoncd123012007-05-09 02:34:50 -07001096 svc_reserve_auth(rqstp, procp->pc_xdrressize<<2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
1098 /* Call the function that processes the request. */
1099 if (!versp->vs_dispatch) {
1100 /* Decode arguments */
1101 xdr = procp->pc_decode;
1102 if (xdr && !xdr(rqstp, argv->iov_base, rqstp->rq_argp))
1103 goto err_garbage;
1104
1105 *statp = procp->pc_func(rqstp, rqstp->rq_argp, rqstp->rq_resp);
1106
1107 /* Encode reply */
J. Bruce Fields9e701c62011-01-02 21:56:36 -05001108 if (rqstp->rq_dropme) {
NeilBrownd343fce2006-10-17 00:10:18 -07001109 if (procp->pc_release)
1110 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1111 goto dropit;
1112 }
Joe Perchesf64f9e72009-11-29 16:55:45 -08001113 if (*statp == rpc_success &&
1114 (xdr = procp->pc_encode) &&
1115 !xdr(rqstp, resv->iov_base+resv->iov_len, rqstp->rq_resp)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 dprintk("svc: failed to encode reply\n");
1117 /* serv->sv_stats->rpcsystemerr++; */
1118 *statp = rpc_system_err;
1119 }
1120 } else {
1121 dprintk("svc: calling dispatcher\n");
1122 if (!versp->vs_dispatch(rqstp, statp)) {
1123 /* Release reply info */
1124 if (procp->pc_release)
1125 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1126 goto dropit;
1127 }
1128 }
1129
1130 /* Check RPC status result */
1131 if (*statp != rpc_success)
1132 resv->iov_len = ((void*)statp) - resv->iov_base + 4;
1133
1134 /* Release reply info */
1135 if (procp->pc_release)
1136 procp->pc_release(rqstp, NULL, rqstp->rq_resp);
1137
1138 if (procp->pc_encode == NULL)
1139 goto dropit;
1140
1141 sendit:
1142 if (svc_authorise(rqstp))
1143 goto dropit;
Ricardo Labiaga1cad7ea2009-04-01 09:23:06 -04001144 return 1; /* Caller can now send it */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145
1146 dropit:
1147 svc_authorise(rqstp); /* doesn't hurt to call this twice */
1148 dprintk("svc: svc_process dropit\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 return 0;
1150
1151err_short_len:
Dr. David Alan Gilbert354ecbb2007-08-25 16:09:27 +01001152 svc_printk(rqstp, "short len %Zd, dropping request\n",
1153 argv->iov_len);
NeilBrown34e9a632007-01-29 13:19:52 -08001154
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 goto dropit; /* drop request */
1156
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157err_bad_rpc:
1158 serv->sv_stats->rpcbadfmt++;
Alexey Dobriyan76994312006-09-26 22:28:46 -07001159 svc_putnl(resv, 1); /* REJECT */
1160 svc_putnl(resv, 0); /* RPC_MISMATCH */
1161 svc_putnl(resv, 2); /* Only RPCv2 supported */
1162 svc_putnl(resv, 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 goto sendit;
1164
1165err_bad_auth:
1166 dprintk("svc: authentication failed (%d)\n", ntohl(auth_stat));
1167 serv->sv_stats->rpcbadauth++;
1168 /* Restore write pointer to location of accept status: */
J.Bruce Fields8f8e05c2006-10-04 02:16:08 -07001169 xdr_ressize_check(rqstp, reply_statp);
Alexey Dobriyan76994312006-09-26 22:28:46 -07001170 svc_putnl(resv, 1); /* REJECT */
1171 svc_putnl(resv, 1); /* AUTH_ERROR */
1172 svc_putnl(resv, ntohl(auth_stat)); /* status */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 goto sendit;
1174
1175err_bad_prog:
Andreas Gruenbacher9ba02632005-06-22 17:16:24 +00001176 dprintk("svc: unknown program %d\n", prog);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 serv->sv_stats->rpcbadfmt++;
Alexey Dobriyan76994312006-09-26 22:28:46 -07001178 svc_putnl(resv, RPC_PROG_UNAVAIL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 goto sendit;
1180
1181err_bad_vers:
Dr. David Alan Gilbert354ecbb2007-08-25 16:09:27 +01001182 svc_printk(rqstp, "unknown version (%d for prog %d, %s)\n",
NeilBrown34e9a632007-01-29 13:19:52 -08001183 vers, prog, progp->pg_name);
1184
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185 serv->sv_stats->rpcbadfmt++;
Alexey Dobriyan76994312006-09-26 22:28:46 -07001186 svc_putnl(resv, RPC_PROG_MISMATCH);
1187 svc_putnl(resv, progp->pg_lovers);
1188 svc_putnl(resv, progp->pg_hivers);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 goto sendit;
1190
1191err_bad_proc:
Dr. David Alan Gilbert354ecbb2007-08-25 16:09:27 +01001192 svc_printk(rqstp, "unknown procedure (%d)\n", proc);
NeilBrown34e9a632007-01-29 13:19:52 -08001193
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 serv->sv_stats->rpcbadfmt++;
Alexey Dobriyan76994312006-09-26 22:28:46 -07001195 svc_putnl(resv, RPC_PROC_UNAVAIL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 goto sendit;
1197
1198err_garbage:
Dr. David Alan Gilbert354ecbb2007-08-25 16:09:27 +01001199 svc_printk(rqstp, "failed to decode args\n");
NeilBrown34e9a632007-01-29 13:19:52 -08001200
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 rpc_stat = rpc_garbage_args;
1202err_bad:
1203 serv->sv_stats->rpcbadfmt++;
Alexey Dobriyan76994312006-09-26 22:28:46 -07001204 svc_putnl(resv, ntohl(rpc_stat));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 goto sendit;
1206}
Trond Myklebust24c37672008-12-23 16:30:12 -05001207EXPORT_SYMBOL_GPL(svc_process);
Greg Banks7adae482006-10-04 02:15:47 -07001208
1209/*
Ricardo Labiaga1cad7ea2009-04-01 09:23:06 -04001210 * Process the RPC request.
1211 */
1212int
1213svc_process(struct svc_rqst *rqstp)
1214{
1215 struct kvec *argv = &rqstp->rq_arg.head[0];
1216 struct kvec *resv = &rqstp->rq_res.head[0];
1217 struct svc_serv *serv = rqstp->rq_server;
1218 u32 dir;
Ricardo Labiaga1cad7ea2009-04-01 09:23:06 -04001219
1220 /*
1221 * Setup response xdr_buf.
1222 * Initially it has just one page
1223 */
1224 rqstp->rq_resused = 1;
1225 resv->iov_base = page_address(rqstp->rq_respages[0]);
1226 resv->iov_len = 0;
1227 rqstp->rq_res.pages = rqstp->rq_respages + 1;
1228 rqstp->rq_res.len = 0;
1229 rqstp->rq_res.page_base = 0;
1230 rqstp->rq_res.page_len = 0;
1231 rqstp->rq_res.buflen = PAGE_SIZE;
1232 rqstp->rq_res.tail[0].iov_base = NULL;
1233 rqstp->rq_res.tail[0].iov_len = 0;
1234
1235 rqstp->rq_xid = svc_getu32(argv);
1236
1237 dir = svc_getnl(argv);
1238 if (dir != 0) {
1239 /* direction != CALL */
1240 svc_printk(rqstp, "bad direction %d, dropping request\n", dir);
1241 serv->sv_stats->rpcbadfmt++;
1242 svc_drop(rqstp);
1243 return 0;
1244 }
1245
Andy Adamson4b5b3ba2011-01-06 02:04:24 +00001246 /* Returns 1 for send, 0 for drop */
1247 if (svc_process_common(rqstp, argv, resv))
1248 return svc_send(rqstp);
1249 else {
1250 svc_drop(rqstp);
1251 return 0;
1252 }
Ricardo Labiaga1cad7ea2009-04-01 09:23:06 -04001253}
1254
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001255#if defined(CONFIG_SUNRPC_BACKCHANNEL)
Ricardo Labiaga4d6bbb62009-04-01 09:23:07 -04001256/*
1257 * Process a backchannel RPC request that arrived over an existing
1258 * outbound connection
1259 */
1260int
1261bc_svc_process(struct svc_serv *serv, struct rpc_rqst *req,
1262 struct svc_rqst *rqstp)
1263{
1264 struct kvec *argv = &rqstp->rq_arg.head[0];
1265 struct kvec *resv = &rqstp->rq_res.head[0];
Ricardo Labiaga4d6bbb62009-04-01 09:23:07 -04001266
1267 /* Build the svc_rqst used by the common processing routine */
Andy Adamson4a19de02011-01-06 02:04:35 +00001268 rqstp->rq_xprt = serv->sv_bc_xprt;
Ricardo Labiaga4d6bbb62009-04-01 09:23:07 -04001269 rqstp->rq_xid = req->rq_xid;
1270 rqstp->rq_prot = req->rq_xprt->prot;
1271 rqstp->rq_server = serv;
1272
1273 rqstp->rq_addrlen = sizeof(req->rq_xprt->addr);
1274 memcpy(&rqstp->rq_addr, &req->rq_xprt->addr, rqstp->rq_addrlen);
1275 memcpy(&rqstp->rq_arg, &req->rq_rcv_buf, sizeof(rqstp->rq_arg));
1276 memcpy(&rqstp->rq_res, &req->rq_snd_buf, sizeof(rqstp->rq_res));
1277
1278 /* reset result send buffer "put" position */
1279 resv->iov_len = 0;
1280
1281 if (rqstp->rq_prot != IPPROTO_TCP) {
1282 printk(KERN_ERR "No support for Non-TCP transports!\n");
1283 BUG();
1284 }
1285
1286 /*
1287 * Skip the next two words because they've already been
1288 * processed in the trasport
1289 */
1290 svc_getu32(argv); /* XID */
1291 svc_getnl(argv); /* CALLDIR */
1292
Andy Adamson4b5b3ba2011-01-06 02:04:24 +00001293 /* Returns 1 for send, 0 for drop */
1294 if (svc_process_common(rqstp, argv, resv)) {
1295 memcpy(&req->rq_snd_buf, &rqstp->rq_res,
1296 sizeof(req->rq_snd_buf));
1297 return bc_send(req);
1298 } else {
1299 /* Nothing to do to drop request */
1300 return 0;
1301 }
Ricardo Labiaga4d6bbb62009-04-01 09:23:07 -04001302}
Trond Myklebust0d961aa2011-07-13 19:24:15 -04001303EXPORT_SYMBOL_GPL(bc_svc_process);
Trond Myklebust9e00abc2011-07-13 19:20:49 -04001304#endif /* CONFIG_SUNRPC_BACKCHANNEL */
Ricardo Labiaga4d6bbb62009-04-01 09:23:07 -04001305
Ricardo Labiaga1cad7ea2009-04-01 09:23:06 -04001306/*
Greg Banks7adae482006-10-04 02:15:47 -07001307 * Return (transport-specific) limit on the rpc payload.
1308 */
1309u32 svc_max_payload(const struct svc_rqst *rqstp)
1310{
Tom Tucker49023152007-12-30 21:07:21 -06001311 u32 max = rqstp->rq_xprt->xpt_class->xcl_max_payload;
Greg Banks7adae482006-10-04 02:15:47 -07001312
NeilBrownc6b0a9f2006-10-06 00:44:05 -07001313 if (rqstp->rq_server->sv_max_payload < max)
1314 max = rqstp->rq_server->sv_max_payload;
Greg Banks7adae482006-10-04 02:15:47 -07001315 return max;
1316}
1317EXPORT_SYMBOL_GPL(svc_max_payload);