Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mszeredi...
[linux-2.6-block.git] / fs / nfs / callback.c
CommitLineData
1da177e4
LT
1/*
2 * linux/fs/nfs/callback.c
3 *
4 * Copyright (C) 2004 Trond Myklebust
5 *
6 * NFSv4 callback handling
7 */
8
1da177e4
LT
9#include <linux/completion.h>
10#include <linux/ip.h>
11#include <linux/module.h>
1da177e4
LT
12#include <linux/sunrpc/svc.h>
13#include <linux/sunrpc/svcsock.h>
14#include <linux/nfs_fs.h>
758201e2 15#include <linux/errno.h>
353ab6e9 16#include <linux/mutex.h>
83144186 17#include <linux/freezer.h>
a277e33c 18#include <linux/kthread.h>
945b34a7 19#include <linux/sunrpc/svcauth_gss.h>
a43cde94 20#include <linux/sunrpc/bc_xprt.h>
14c85021
ACM
21
22#include <net/inet_sock.h>
23
4ce79717 24#include "nfs4_fs.h"
1da177e4 25#include "callback.h"
24c8dbbb 26#include "internal.h"
bbe0a3aa 27#include "netns.h"
1da177e4
LT
28
29#define NFSDBG_FACILITY NFSDBG_CALLBACK
30
31struct nfs_callback_data {
32 unsigned int users;
a43cde94 33 struct svc_serv *serv;
5afc597c 34 struct svc_rqst *rqst;
a277e33c 35 struct task_struct *task;
1da177e4
LT
36};
37
e82dc22d 38static struct nfs_callback_data nfs_callback_info[NFS4_MAX_MINOR_VERSION + 1];
353ab6e9 39static DEFINE_MUTEX(nfs_callback_mutex);
1da177e4
LT
40static struct svc_program nfs4_callback_program;
41
c946556b
SK
42static int nfs4_callback_up_net(struct svc_serv *serv, struct net *net)
43{
44 int ret;
bbe0a3aa 45 struct nfs_net *nn = net_generic(net, nfs_net_id);
c946556b
SK
46
47 ret = svc_create_xprt(serv, "tcp", net, PF_INET,
48 nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS);
49 if (ret <= 0)
50 goto out_err;
bbe0a3aa 51 nn->nfs_callback_tcpport = ret;
c946556b 52 dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
bbe0a3aa 53 nn->nfs_callback_tcpport, PF_INET, net);
c946556b
SK
54
55 ret = svc_create_xprt(serv, "tcp", net, PF_INET6,
56 nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS);
57 if (ret > 0) {
29dcc16a 58 nn->nfs_callback_tcpport6 = ret;
c946556b 59 dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
29dcc16a 60 nn->nfs_callback_tcpport6, PF_INET6, net);
c946556b
SK
61 } else if (ret != -EAFNOSUPPORT)
62 goto out_err;
63 return 0;
64
65out_err:
66 return (ret) ? ret : -ENOMEM;
67}
68
1da177e4 69/*
e82dc22d 70 * This is the NFSv4 callback kernel thread.
1da177e4 71 */
a277e33c 72static int
71468513 73nfs4_callback_svc(void *vrqstp)
1da177e4 74{
5b444cc9 75 int err;
a277e33c 76 struct svc_rqst *rqstp = vrqstp;
1da177e4 77
83144186 78 set_freezable();
1da177e4 79
a277e33c 80 while (!kthread_should_stop()) {
1da177e4
LT
81 /*
82 * Listen for a request on the socket
83 */
6fb2b47f 84 err = svc_recv(rqstp, MAX_SCHEDULE_TIMEOUT);
5b444cc9 85 if (err == -EAGAIN || err == -EINTR)
1da177e4 86 continue;
6fb2b47f 87 svc_process(rqstp);
1da177e4 88 }
a277e33c 89 return 0;
1da177e4
LT
90}
91
92/*
71468513 93 * Prepare to bring up the NFSv4 callback service
1da177e4 94 */
17280175 95static struct svc_rqst *
691c457a 96nfs4_callback_up(struct svc_serv *serv)
1da177e4 97{
11fd165c 98 return svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
71468513
BH
99}
100
a43cde94 101#if defined(CONFIG_NFS_V4_1)
c946556b
SK
102static int nfs41_callback_up_net(struct svc_serv *serv, struct net *net)
103{
104 /*
105 * Create an svc_sock for the back channel service that shares the
106 * fore channel connection.
107 * Returns the input port (0) and sets the svc_serv bc_xprt on success
108 */
109 return svc_create_xprt(serv, "tcp-bc", net, PF_INET, 0,
110 SVC_SOCK_ANONYMOUS);
111}
112
a43cde94
RL
113/*
114 * The callback service for NFSv4.1 callbacks
115 */
116static int
117nfs41_callback_svc(void *vrqstp)
118{
119 struct svc_rqst *rqstp = vrqstp;
120 struct svc_serv *serv = rqstp->rq_server;
121 struct rpc_rqst *req;
122 int error;
123 DEFINE_WAIT(wq);
124
125 set_freezable();
126
a43cde94 127 while (!kthread_should_stop()) {
25d280aa
JL
128 if (try_to_freeze())
129 continue;
130
a43cde94
RL
131 prepare_to_wait(&serv->sv_cb_waitq, &wq, TASK_INTERRUPTIBLE);
132 spin_lock_bh(&serv->sv_cb_lock);
133 if (!list_empty(&serv->sv_cb_list)) {
134 req = list_first_entry(&serv->sv_cb_list,
135 struct rpc_rqst, rq_bc_list);
136 list_del(&req->rq_bc_list);
137 spin_unlock_bh(&serv->sv_cb_lock);
138 dprintk("Invoking bc_svc_process()\n");
139 error = bc_svc_process(serv, req, rqstp);
140 dprintk("bc_svc_process() returned w/ error code= %d\n",
141 error);
142 } else {
143 spin_unlock_bh(&serv->sv_cb_lock);
144 schedule();
145 }
146 finish_wait(&serv->sv_cb_waitq, &wq);
147 }
a43cde94
RL
148 return 0;
149}
150
151/*
152 * Bring up the NFSv4.1 callback service
153 */
17280175 154static struct svc_rqst *
691c457a 155nfs41_callback_up(struct svc_serv *serv)
a43cde94 156{
01c9a0bc 157 struct svc_rqst *rqstp;
8f975242 158
a43cde94
RL
159 INIT_LIST_HEAD(&serv->sv_cb_list);
160 spin_lock_init(&serv->sv_cb_lock);
161 init_waitqueue_head(&serv->sv_cb_waitq);
11fd165c 162 rqstp = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
01c9a0bc 163 if (IS_ERR(rqstp)) {
4a19de0f
AA
164 svc_xprt_put(serv->sv_bc_xprt);
165 serv->sv_bc_xprt = NULL;
01c9a0bc 166 }
54bcfa66 167 dprintk("--> %s return %d\n", __func__, PTR_ERR_OR_ZERO(rqstp));
8f975242 168 return rqstp;
a43cde94
RL
169}
170
758201e2 171static void nfs_minorversion_callback_svc_setup(struct svc_serv *serv,
a43cde94
RL
172 struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
173{
758201e2
TM
174 *rqstpp = nfs41_callback_up(serv);
175 *callback_svc = nfs41_callback_svc;
a43cde94
RL
176}
177
178static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
691c457a 179 struct svc_serv *serv)
a43cde94
RL
180{
181 if (minorversion)
691c457a
SK
182 /*
183 * Save the svc_serv in the transport so that it can
184 * be referenced when the session backchannel is initialized
185 */
186 xprt->bc_serv = serv;
a43cde94
RL
187}
188#else
c946556b
SK
189static int nfs41_callback_up_net(struct svc_serv *serv, struct net *net)
190{
191 return 0;
192}
193
758201e2 194static void nfs_minorversion_callback_svc_setup(struct svc_serv *serv,
a43cde94
RL
195 struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
196{
758201e2
TM
197 *rqstpp = ERR_PTR(-ENOTSUPP);
198 *callback_svc = ERR_PTR(-ENOTSUPP);
a43cde94
RL
199}
200
201static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
691c457a 202 struct svc_serv *serv)
a43cde94
RL
203{
204}
205#endif /* CONFIG_NFS_V4_1 */
206
8e246144
SK
207static int nfs_callback_start_svc(int minorversion, struct rpc_xprt *xprt,
208 struct svc_serv *serv)
209{
210 struct svc_rqst *rqstp;
211 int (*callback_svc)(void *vrqstp);
212 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
8e246144 213 int ret;
8e246144
SK
214
215 nfs_callback_bc_serv(minorversion, xprt, serv);
216
23c20ecd
SK
217 if (cb_info->task)
218 return 0;
219
758201e2
TM
220 switch (minorversion) {
221 case 0:
8e246144
SK
222 /* v4.0 callback setup */
223 rqstp = nfs4_callback_up(serv);
224 callback_svc = nfs4_callback_svc;
758201e2
TM
225 break;
226 default:
227 nfs_minorversion_callback_svc_setup(serv,
228 &rqstp, &callback_svc);
8e246144
SK
229 }
230
231 if (IS_ERR(rqstp))
232 return PTR_ERR(rqstp);
233
234 svc_sock_update_bufs(serv);
235
8e246144
SK
236 cb_info->serv = serv;
237 cb_info->rqst = rqstp;
66f09ca7 238 cb_info->task = kthread_create(callback_svc, cb_info->rqst,
f170168b 239 "nfsv4.%u-svc", minorversion);
8e246144
SK
240 if (IS_ERR(cb_info->task)) {
241 ret = PTR_ERR(cb_info->task);
242 svc_exit_thread(cb_info->rqst);
243 cb_info->rqst = NULL;
244 cb_info->task = NULL;
e9b7e917 245 return ret;
8e246144 246 }
88799977 247 rqstp->rq_task = cb_info->task;
66f09ca7 248 wake_up_process(cb_info->task);
8e246144
SK
249 dprintk("nfs_callback_up: service started\n");
250 return 0;
251}
252
b3d19c51
SK
253static void nfs_callback_down_net(u32 minorversion, struct svc_serv *serv, struct net *net)
254{
255 struct nfs_net *nn = net_generic(net, nfs_net_id);
256
257 if (--nn->cb_users[minorversion])
258 return;
259
260 dprintk("NFS: destroy per-net callback data; net=%p\n", net);
261 svc_shutdown_net(serv, net);
262}
263
c946556b
SK
264static int nfs_callback_up_net(int minorversion, struct svc_serv *serv, struct net *net)
265{
b3d19c51 266 struct nfs_net *nn = net_generic(net, nfs_net_id);
c946556b
SK
267 int ret;
268
b3d19c51
SK
269 if (nn->cb_users[minorversion]++)
270 return 0;
271
c946556b
SK
272 dprintk("NFS: create per-net callback data; net=%p\n", net);
273
274 ret = svc_bind(serv, net);
275 if (ret < 0) {
276 printk(KERN_WARNING "NFS: bind callback service failed\n");
277 goto err_bind;
278 }
279
280 switch (minorversion) {
281 case 0:
282 ret = nfs4_callback_up_net(serv, net);
283 break;
284 case 1:
42c2c424 285 case 2:
c946556b
SK
286 ret = nfs41_callback_up_net(serv, net);
287 break;
288 default:
289 printk(KERN_ERR "NFS: unknown callback version: %d\n",
290 minorversion);
291 ret = -EINVAL;
292 break;
293 }
294
295 if (ret < 0) {
296 printk(KERN_ERR "NFS: callback service start failed\n");
297 goto err_socks;
298 }
299 return 0;
300
301err_socks:
302 svc_rpcb_cleanup(serv, net);
303err_bind:
23c20ecd
SK
304 dprintk("NFS: Couldn't create callback socket: err = %d; "
305 "net = %p\n", ret, net);
c946556b
SK
306 return ret;
307}
308
dd018428
SK
309static struct svc_serv *nfs_callback_create_svc(int minorversion)
310{
311 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
312 struct svc_serv *serv;
313
314 /*
315 * Check whether we're already up and running.
316 */
317 if (cb_info->task) {
318 /*
319 * Note: increase service usage, because later in case of error
320 * svc_destroy() will be called.
321 */
322 svc_get(cb_info->serv);
323 return cb_info->serv;
324 }
325
326 /*
327 * Sanity check: if there's no task,
328 * we should be the first user ...
329 */
330 if (cb_info->users)
331 printk(KERN_WARNING "nfs_callback_create_svc: no kthread, %d users??\n",
332 cb_info->users);
333
334 serv = svc_create(&nfs4_callback_program, NFS4_CALLBACK_BUFSIZE, NULL);
335 if (!serv) {
336 printk(KERN_ERR "nfs_callback_create_svc: create service failed\n");
337 return ERR_PTR(-ENOMEM);
338 }
339 /* As there is only one thread we need to over-ride the
340 * default maximum of 80 connections
341 */
342 serv->sv_maxconn = 1024;
343 dprintk("nfs_callback_create_svc: service created\n");
344 return serv;
345}
346
71468513
BH
347/*
348 * Bring up the callback thread if it is not already up.
349 */
350int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt)
351{
dd018428 352 struct svc_serv *serv;
e82dc22d 353 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
23c20ecd 354 int ret;
c946556b 355 struct net *net = xprt->xprt_net;
71468513
BH
356
357 mutex_lock(&nfs_callback_mutex);
dd018428
SK
358
359 serv = nfs_callback_create_svc(minorversion);
360 if (IS_ERR(serv)) {
361 ret = PTR_ERR(serv);
362 goto err_create;
363 }
364
c946556b
SK
365 ret = nfs_callback_up_net(minorversion, serv, net);
366 if (ret < 0)
367 goto err_net;
9793f7c8 368
8e246144
SK
369 ret = nfs_callback_start_svc(minorversion, xprt, serv);
370 if (ret < 0)
371 goto err_start;
a277e33c 372
23c20ecd 373 cb_info->users++;
8e60029f
JL
374 /*
375 * svc_create creates the svc_serv with sv_nrthreads == 1, and then
a277e33c 376 * svc_prepare_thread increments that. So we need to call svc_destroy
8e60029f
JL
377 * on both success and failure so that the refcount is 1 when the
378 * thread exits.
379 */
23c20ecd 380err_net:
dd018428
SK
381 svc_destroy(serv);
382err_create:
353ab6e9 383 mutex_unlock(&nfs_callback_mutex);
1da177e4 384 return ret;
8e246144
SK
385
386err_start:
b3d19c51 387 nfs_callback_down_net(minorversion, serv, net);
23c20ecd
SK
388 dprintk("NFS: Couldn't create server thread; err = %d\n", ret);
389 goto err_net;
1da177e4
LT
390}
391
392/*
5afc597c 393 * Kill the callback thread if it's no longer being used.
1da177e4 394 */
c8ceb412 395void nfs_callback_down(int minorversion, struct net *net)
1da177e4 396{
e82dc22d
AA
397 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
398
353ab6e9 399 mutex_lock(&nfs_callback_mutex);
b3d19c51 400 nfs_callback_down_net(minorversion, cb_info->serv, net);
e82dc22d
AA
401 cb_info->users--;
402 if (cb_info->users == 0 && cb_info->task != NULL) {
403 kthread_stop(cb_info->task);
1dc42e04 404 dprintk("nfs_callback_down: service stopped\n");
e82dc22d 405 svc_exit_thread(cb_info->rqst);
1dc42e04 406 dprintk("nfs_callback_down: service destroyed\n");
e82dc22d
AA
407 cb_info->serv = NULL;
408 cb_info->rqst = NULL;
409 cb_info->task = NULL;
5afc597c 410 }
353ab6e9 411 mutex_unlock(&nfs_callback_mutex);
1da177e4
LT
412}
413
778be232
AA
414/* Boolean check of RPC_AUTH_GSS principal */
415int
416check_gss_callback_principal(struct nfs_client *clp, struct svc_rqst *rqstp)
945b34a7 417{
03a4e1f6 418 char *p = rqstp->rq_cred.cr_principal;
945b34a7 419
778be232
AA
420 if (rqstp->rq_authop->flavour != RPC_AUTH_GSS)
421 return 1;
422
ece0de63
AA
423 /* No RPC_AUTH_GSS on NFSv4.1 back channel yet */
424 if (clp->cl_minorversion != 0)
778be232 425 return 0;
945b34a7
OK
426 /*
427 * It might just be a normal user principal, in which case
428 * userspace won't bother to tell us the name at all.
429 */
430 if (p == NULL)
778be232 431 return 0;
945b34a7 432
f11b2a1c
JL
433 /*
434 * Did we get the acceptor from userland during the SETCLIENID
435 * negotiation?
436 */
437 if (clp->cl_acceptor)
438 return !strcmp(p, clp->cl_acceptor);
439
440 /*
441 * Otherwise try to verify it using the cl_hostname. Note that this
442 * doesn't work if a non-canonical hostname was used in the devname.
443 */
444
945b34a7
OK
445 /* Expect a GSS_C_NT_HOSTBASED_NAME like "nfs@serverhostname" */
446
447 if (memcmp(p, "nfs@", 4) != 0)
778be232 448 return 0;
945b34a7 449 p += 4;
4e0038b6 450 if (strcmp(p, clp->cl_hostname) != 0)
778be232
AA
451 return 0;
452 return 1;
945b34a7
OK
453}
454
778be232
AA
455/*
456 * pg_authenticate method for nfsv4 callback threads.
457 *
458 * The authflavor has been negotiated, so an incorrect flavor is a server
459 * bug. Drop packets with incorrect authflavor.
460 *
461 * All other checking done after NFS decoding where the nfs_client can be
462 * found in nfs4_callback_compound
463 */
1da177e4
LT
464static int nfs_callback_authenticate(struct svc_rqst *rqstp)
465{
1da177e4 466 switch (rqstp->rq_authop->flavour) {
778be232
AA
467 case RPC_AUTH_NULL:
468 if (rqstp->rq_proc != CB_NULL)
469 return SVC_DROP;
470 break;
471 case RPC_AUTH_GSS:
472 /* No RPC_AUTH_GSS support yet in NFSv4.1 */
473 if (svc_is_backchannel(rqstp))
474 return SVC_DROP;
1da177e4 475 }
778be232 476 return SVC_OK;
1da177e4
LT
477}
478
479/*
480 * Define NFS4 callback program
481 */
1da177e4
LT
482static struct svc_version *nfs4_callback_version[] = {
483 [1] = &nfs4_callback_version1,
07bccc2d 484 [4] = &nfs4_callback_version4,
1da177e4
LT
485};
486
487static struct svc_stat nfs4_callback_stats;
488
489static struct svc_program nfs4_callback_program = {
490 .pg_prog = NFS4_CALLBACK, /* RPC service number */
491 .pg_nvers = ARRAY_SIZE(nfs4_callback_version), /* Number of entries */
492 .pg_vers = nfs4_callback_version, /* version table */
493 .pg_name = "NFSv4 callback", /* service name */
494 .pg_class = "nfs", /* authentication class */
495 .pg_stats = &nfs4_callback_stats,
496 .pg_authenticate = nfs_callback_authenticate,
497};