Merge remote-tracking branch 'ftrace/for-next'
[deliverable/linux.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
RL
101#if defined(CONFIG_NFS_V4_1)
102/*
103 * The callback service for NFSv4.1 callbacks
104 */
105static int
106nfs41_callback_svc(void *vrqstp)
107{
108 struct svc_rqst *rqstp = vrqstp;
109 struct svc_serv *serv = rqstp->rq_server;
110 struct rpc_rqst *req;
111 int error;
112 DEFINE_WAIT(wq);
113
114 set_freezable();
115
a43cde94 116 while (!kthread_should_stop()) {
25d280aa
JL
117 if (try_to_freeze())
118 continue;
119
5d05e54a 120 prepare_to_wait(&serv->sv_cb_waitq, &wq, TASK_INTERRUPTIBLE);
a43cde94
RL
121 spin_lock_bh(&serv->sv_cb_lock);
122 if (!list_empty(&serv->sv_cb_list)) {
123 req = list_first_entry(&serv->sv_cb_list,
124 struct rpc_rqst, rq_bc_list);
125 list_del(&req->rq_bc_list);
126 spin_unlock_bh(&serv->sv_cb_lock);
6ffa30d3 127 finish_wait(&serv->sv_cb_waitq, &wq);
a43cde94
RL
128 dprintk("Invoking bc_svc_process()\n");
129 error = bc_svc_process(serv, req, rqstp);
130 dprintk("bc_svc_process() returned w/ error code= %d\n",
131 error);
132 } else {
133 spin_unlock_bh(&serv->sv_cb_lock);
5d05e54a 134 schedule();
6ffa30d3 135 finish_wait(&serv->sv_cb_waitq, &wq);
a43cde94 136 }
5d05e54a 137 flush_signals(current);
a43cde94 138 }
a43cde94
RL
139 return 0;
140}
141
142/*
143 * Bring up the NFSv4.1 callback service
144 */
17280175 145static struct svc_rqst *
691c457a 146nfs41_callback_up(struct svc_serv *serv)
a43cde94 147{
01c9a0bc 148 struct svc_rqst *rqstp;
8f975242 149
a43cde94
RL
150 INIT_LIST_HEAD(&serv->sv_cb_list);
151 spin_lock_init(&serv->sv_cb_lock);
152 init_waitqueue_head(&serv->sv_cb_waitq);
11fd165c 153 rqstp = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
54bcfa66 154 dprintk("--> %s return %d\n", __func__, PTR_ERR_OR_ZERO(rqstp));
8f975242 155 return rqstp;
a43cde94
RL
156}
157
758201e2 158static void nfs_minorversion_callback_svc_setup(struct svc_serv *serv,
a43cde94
RL
159 struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
160{
758201e2
TM
161 *rqstpp = nfs41_callback_up(serv);
162 *callback_svc = nfs41_callback_svc;
a43cde94
RL
163}
164
165static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
691c457a 166 struct svc_serv *serv)
a43cde94
RL
167{
168 if (minorversion)
691c457a
SK
169 /*
170 * Save the svc_serv in the transport so that it can
171 * be referenced when the session backchannel is initialized
172 */
173 xprt->bc_serv = serv;
a43cde94
RL
174}
175#else
758201e2 176static void nfs_minorversion_callback_svc_setup(struct svc_serv *serv,
a43cde94
RL
177 struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
178{
758201e2
TM
179 *rqstpp = ERR_PTR(-ENOTSUPP);
180 *callback_svc = ERR_PTR(-ENOTSUPP);
a43cde94
RL
181}
182
183static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
691c457a 184 struct svc_serv *serv)
a43cde94
RL
185{
186}
187#endif /* CONFIG_NFS_V4_1 */
188
8e246144
SK
189static int nfs_callback_start_svc(int minorversion, struct rpc_xprt *xprt,
190 struct svc_serv *serv)
191{
192 struct svc_rqst *rqstp;
193 int (*callback_svc)(void *vrqstp);
194 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
8e246144 195 int ret;
8e246144
SK
196
197 nfs_callback_bc_serv(minorversion, xprt, serv);
198
23c20ecd
SK
199 if (cb_info->task)
200 return 0;
201
758201e2
TM
202 switch (minorversion) {
203 case 0:
8e246144
SK
204 /* v4.0 callback setup */
205 rqstp = nfs4_callback_up(serv);
206 callback_svc = nfs4_callback_svc;
758201e2
TM
207 break;
208 default:
209 nfs_minorversion_callback_svc_setup(serv,
210 &rqstp, &callback_svc);
8e246144
SK
211 }
212
213 if (IS_ERR(rqstp))
214 return PTR_ERR(rqstp);
215
216 svc_sock_update_bufs(serv);
217
8e246144
SK
218 cb_info->serv = serv;
219 cb_info->rqst = rqstp;
66f09ca7 220 cb_info->task = kthread_create(callback_svc, cb_info->rqst,
f170168b 221 "nfsv4.%u-svc", minorversion);
8e246144
SK
222 if (IS_ERR(cb_info->task)) {
223 ret = PTR_ERR(cb_info->task);
224 svc_exit_thread(cb_info->rqst);
225 cb_info->rqst = NULL;
226 cb_info->task = NULL;
e9b7e917 227 return ret;
8e246144 228 }
88799977 229 rqstp->rq_task = cb_info->task;
66f09ca7 230 wake_up_process(cb_info->task);
8e246144
SK
231 dprintk("nfs_callback_up: service started\n");
232 return 0;
233}
234
b3d19c51
SK
235static void nfs_callback_down_net(u32 minorversion, struct svc_serv *serv, struct net *net)
236{
237 struct nfs_net *nn = net_generic(net, nfs_net_id);
238
239 if (--nn->cb_users[minorversion])
240 return;
241
242 dprintk("NFS: destroy per-net callback data; net=%p\n", net);
243 svc_shutdown_net(serv, net);
244}
245
76566773
CL
246static int nfs_callback_up_net(int minorversion, struct svc_serv *serv,
247 struct net *net, struct rpc_xprt *xprt)
c946556b 248{
b3d19c51 249 struct nfs_net *nn = net_generic(net, nfs_net_id);
c946556b
SK
250 int ret;
251
b3d19c51
SK
252 if (nn->cb_users[minorversion]++)
253 return 0;
254
c946556b
SK
255 dprintk("NFS: create per-net callback data; net=%p\n", net);
256
257 ret = svc_bind(serv, net);
258 if (ret < 0) {
259 printk(KERN_WARNING "NFS: bind callback service failed\n");
260 goto err_bind;
261 }
262
76566773
CL
263 ret = -EPROTONOSUPPORT;
264 if (minorversion == 0)
265 ret = nfs4_callback_up_net(serv, net);
266 else if (xprt->ops->bc_up)
267 ret = xprt->ops->bc_up(serv, net);
c946556b
SK
268
269 if (ret < 0) {
270 printk(KERN_ERR "NFS: callback service start failed\n");
271 goto err_socks;
272 }
273 return 0;
274
275err_socks:
276 svc_rpcb_cleanup(serv, net);
277err_bind:
98b0f80c 278 nn->cb_users[minorversion]--;
23c20ecd
SK
279 dprintk("NFS: Couldn't create callback socket: err = %d; "
280 "net = %p\n", ret, net);
c946556b
SK
281 return ret;
282}
283
ea126e74 284static struct svc_serv_ops nfs_cb_sv_ops = {
b9e13cdf 285 .svo_enqueue_xprt = svc_xprt_do_enqueue,
ea126e74
JL
286};
287
dd018428
SK
288static struct svc_serv *nfs_callback_create_svc(int minorversion)
289{
290 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
291 struct svc_serv *serv;
292
293 /*
294 * Check whether we're already up and running.
295 */
296 if (cb_info->task) {
297 /*
298 * Note: increase service usage, because later in case of error
299 * svc_destroy() will be called.
300 */
301 svc_get(cb_info->serv);
302 return cb_info->serv;
303 }
304
305 /*
306 * Sanity check: if there's no task,
307 * we should be the first user ...
308 */
309 if (cb_info->users)
310 printk(KERN_WARNING "nfs_callback_create_svc: no kthread, %d users??\n",
311 cb_info->users);
312
ea126e74 313 serv = svc_create(&nfs4_callback_program, NFS4_CALLBACK_BUFSIZE, &nfs_cb_sv_ops);
dd018428
SK
314 if (!serv) {
315 printk(KERN_ERR "nfs_callback_create_svc: create service failed\n");
316 return ERR_PTR(-ENOMEM);
317 }
318 /* As there is only one thread we need to over-ride the
319 * default maximum of 80 connections
320 */
321 serv->sv_maxconn = 1024;
322 dprintk("nfs_callback_create_svc: service created\n");
323 return serv;
324}
325
71468513
BH
326/*
327 * Bring up the callback thread if it is not already up.
328 */
329int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt)
330{
dd018428 331 struct svc_serv *serv;
e82dc22d 332 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
23c20ecd 333 int ret;
c946556b 334 struct net *net = xprt->xprt_net;
71468513
BH
335
336 mutex_lock(&nfs_callback_mutex);
dd018428
SK
337
338 serv = nfs_callback_create_svc(minorversion);
339 if (IS_ERR(serv)) {
340 ret = PTR_ERR(serv);
341 goto err_create;
342 }
343
76566773 344 ret = nfs_callback_up_net(minorversion, serv, net, xprt);
c946556b
SK
345 if (ret < 0)
346 goto err_net;
9793f7c8 347
8e246144
SK
348 ret = nfs_callback_start_svc(minorversion, xprt, serv);
349 if (ret < 0)
350 goto err_start;
a277e33c 351
23c20ecd 352 cb_info->users++;
8e60029f
JL
353 /*
354 * svc_create creates the svc_serv with sv_nrthreads == 1, and then
a277e33c 355 * svc_prepare_thread increments that. So we need to call svc_destroy
8e60029f
JL
356 * on both success and failure so that the refcount is 1 when the
357 * thread exits.
358 */
23c20ecd 359err_net:
dd018428
SK
360 svc_destroy(serv);
361err_create:
353ab6e9 362 mutex_unlock(&nfs_callback_mutex);
1da177e4 363 return ret;
8e246144
SK
364
365err_start:
b3d19c51 366 nfs_callback_down_net(minorversion, serv, net);
23c20ecd
SK
367 dprintk("NFS: Couldn't create server thread; err = %d\n", ret);
368 goto err_net;
1da177e4
LT
369}
370
371/*
5afc597c 372 * Kill the callback thread if it's no longer being used.
1da177e4 373 */
c8ceb412 374void nfs_callback_down(int minorversion, struct net *net)
1da177e4 375{
e82dc22d
AA
376 struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
377
353ab6e9 378 mutex_lock(&nfs_callback_mutex);
b3d19c51 379 nfs_callback_down_net(minorversion, cb_info->serv, net);
e82dc22d
AA
380 cb_info->users--;
381 if (cb_info->users == 0 && cb_info->task != NULL) {
382 kthread_stop(cb_info->task);
1dc42e04 383 dprintk("nfs_callback_down: service stopped\n");
e82dc22d 384 svc_exit_thread(cb_info->rqst);
1dc42e04 385 dprintk("nfs_callback_down: service destroyed\n");
e82dc22d
AA
386 cb_info->serv = NULL;
387 cb_info->rqst = NULL;
388 cb_info->task = NULL;
5afc597c 389 }
353ab6e9 390 mutex_unlock(&nfs_callback_mutex);
1da177e4
LT
391}
392
778be232
AA
393/* Boolean check of RPC_AUTH_GSS principal */
394int
395check_gss_callback_principal(struct nfs_client *clp, struct svc_rqst *rqstp)
945b34a7 396{
03a4e1f6 397 char *p = rqstp->rq_cred.cr_principal;
945b34a7 398
778be232
AA
399 if (rqstp->rq_authop->flavour != RPC_AUTH_GSS)
400 return 1;
401
ece0de63
AA
402 /* No RPC_AUTH_GSS on NFSv4.1 back channel yet */
403 if (clp->cl_minorversion != 0)
778be232 404 return 0;
945b34a7
OK
405 /*
406 * It might just be a normal user principal, in which case
407 * userspace won't bother to tell us the name at all.
408 */
409 if (p == NULL)
778be232 410 return 0;
945b34a7 411
f11b2a1c
JL
412 /*
413 * Did we get the acceptor from userland during the SETCLIENID
414 * negotiation?
415 */
416 if (clp->cl_acceptor)
417 return !strcmp(p, clp->cl_acceptor);
418
419 /*
420 * Otherwise try to verify it using the cl_hostname. Note that this
421 * doesn't work if a non-canonical hostname was used in the devname.
422 */
423
945b34a7
OK
424 /* Expect a GSS_C_NT_HOSTBASED_NAME like "nfs@serverhostname" */
425
426 if (memcmp(p, "nfs@", 4) != 0)
778be232 427 return 0;
945b34a7 428 p += 4;
4e0038b6 429 if (strcmp(p, clp->cl_hostname) != 0)
778be232
AA
430 return 0;
431 return 1;
945b34a7
OK
432}
433
778be232
AA
434/*
435 * pg_authenticate method for nfsv4 callback threads.
436 *
437 * The authflavor has been negotiated, so an incorrect flavor is a server
6f02dc88 438 * bug. Deny packets with incorrect authflavor.
778be232
AA
439 *
440 * All other checking done after NFS decoding where the nfs_client can be
441 * found in nfs4_callback_compound
442 */
1da177e4
LT
443static int nfs_callback_authenticate(struct svc_rqst *rqstp)
444{
1da177e4 445 switch (rqstp->rq_authop->flavour) {
778be232
AA
446 case RPC_AUTH_NULL:
447 if (rqstp->rq_proc != CB_NULL)
6f02dc88 448 return SVC_DENIED;
778be232
AA
449 break;
450 case RPC_AUTH_GSS:
451 /* No RPC_AUTH_GSS support yet in NFSv4.1 */
452 if (svc_is_backchannel(rqstp))
6f02dc88 453 return SVC_DENIED;
1da177e4 454 }
778be232 455 return SVC_OK;
1da177e4
LT
456}
457
458/*
459 * Define NFS4 callback program
460 */
1da177e4
LT
461static struct svc_version *nfs4_callback_version[] = {
462 [1] = &nfs4_callback_version1,
07bccc2d 463 [4] = &nfs4_callback_version4,
1da177e4
LT
464};
465
466static struct svc_stat nfs4_callback_stats;
467
468static struct svc_program nfs4_callback_program = {
469 .pg_prog = NFS4_CALLBACK, /* RPC service number */
470 .pg_nvers = ARRAY_SIZE(nfs4_callback_version), /* Number of entries */
471 .pg_vers = nfs4_callback_version, /* version table */
472 .pg_name = "NFSv4 callback", /* service name */
473 .pg_class = "nfs", /* authentication class */
474 .pg_stats = &nfs4_callback_stats,
475 .pg_authenticate = nfs_callback_authenticate,
476};
This page took 0.811537 seconds and 5 git commands to generate.