callback.c 11.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * linux/fs/nfs/callback.c
 *
 * Copyright (C) 2004 Trond Myklebust
 *
 * NFSv4 callback handling
 */

#include <linux/completion.h>
#include <linux/ip.h>
#include <linux/module.h>
#include <linux/sunrpc/svc.h>
#include <linux/sunrpc/svcsock.h>
#include <linux/nfs_fs.h>
I
Ingo Molnar 已提交
15
#include <linux/mutex.h>
16
#include <linux/freezer.h>
17
#include <linux/kthread.h>
18
#include <linux/sunrpc/svcauth_gss.h>
19
#include <linux/sunrpc/bc_xprt.h>
20 21 22

#include <net/inet_sock.h>

23
#include "nfs4_fs.h"
L
Linus Torvalds 已提交
24
#include "callback.h"
25
#include "internal.h"
26
#include "netns.h"
L
Linus Torvalds 已提交
27 28 29 30 31

#define NFSDBG_FACILITY NFSDBG_CALLBACK

struct nfs_callback_data {
	unsigned int users;
32
	struct svc_serv *serv;
33
	struct svc_rqst *rqst;
34
	struct task_struct *task;
L
Linus Torvalds 已提交
35 36
};

37
static struct nfs_callback_data nfs_callback_info[NFS4_MAX_MINOR_VERSION + 1];
I
Ingo Molnar 已提交
38
static DEFINE_MUTEX(nfs_callback_mutex);
L
Linus Torvalds 已提交
39 40
static struct svc_program nfs4_callback_program;

41 42 43
static int nfs4_callback_up_net(struct svc_serv *serv, struct net *net)
{
	int ret;
44
	struct nfs_net *nn = net_generic(net, nfs_net_id);
45 46 47 48 49

	ret = svc_create_xprt(serv, "tcp", net, PF_INET,
				nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS);
	if (ret <= 0)
		goto out_err;
50
	nn->nfs_callback_tcpport = ret;
51
	dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
52
			nn->nfs_callback_tcpport, PF_INET, net);
53 54 55 56

	ret = svc_create_xprt(serv, "tcp", net, PF_INET6,
				nfs_callback_set_tcpport, SVC_SOCK_ANONYMOUS);
	if (ret > 0) {
57
		nn->nfs_callback_tcpport6 = ret;
58
		dprintk("NFS: Callback listener port = %u (af %u, net %p)\n",
59
				nn->nfs_callback_tcpport6, PF_INET6, net);
60 61 62 63 64 65 66 67
	} else if (ret != -EAFNOSUPPORT)
		goto out_err;
	return 0;

out_err:
	return (ret) ? ret : -ENOMEM;
}

L
Linus Torvalds 已提交
68
/*
69
 * This is the NFSv4 callback kernel thread.
L
Linus Torvalds 已提交
70
 */
71
static int
72
nfs4_callback_svc(void *vrqstp)
L
Linus Torvalds 已提交
73
{
74
	int err, preverr = 0;
75
	struct svc_rqst *rqstp = vrqstp;
L
Linus Torvalds 已提交
76

77
	set_freezable();
L
Linus Torvalds 已提交
78

79
	while (!kthread_should_stop()) {
L
Linus Torvalds 已提交
80 81 82
		/*
		 * Listen for a request on the socket
		 */
83
		err = svc_recv(rqstp, MAX_SCHEDULE_TIMEOUT);
84 85
		if (err == -EAGAIN || err == -EINTR) {
			preverr = err;
L
Linus Torvalds 已提交
86
			continue;
87
		}
L
Linus Torvalds 已提交
88
		if (err < 0) {
89
			if (err != preverr) {
90
				printk(KERN_WARNING "NFS: %s: unexpected error "
91 92 93 94 95
					"from svc_recv (%d)\n", __func__, err);
				preverr = err;
			}
			schedule_timeout_uninterruptible(HZ);
			continue;
L
Linus Torvalds 已提交
96
		}
97
		preverr = err;
98
		svc_process(rqstp);
L
Linus Torvalds 已提交
99
	}
100
	return 0;
L
Linus Torvalds 已提交
101 102 103
}

/*
104
 * Prepare to bring up the NFSv4 callback service
L
Linus Torvalds 已提交
105
 */
106
static struct svc_rqst *
107
nfs4_callback_up(struct svc_serv *serv)
L
Linus Torvalds 已提交
108
{
109
	return svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
110 111
}

112
#if defined(CONFIG_NFS_V4_1)
113 114 115 116 117 118 119 120 121 122 123
static int nfs41_callback_up_net(struct svc_serv *serv, struct net *net)
{
	/*
	 * Create an svc_sock for the back channel service that shares the
	 * fore channel connection.
	 * Returns the input port (0) and sets the svc_serv bc_xprt on success
	 */
	return svc_create_xprt(serv, "tcp-bc", net, PF_INET, 0,
			      SVC_SOCK_ANONYMOUS);
}

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
/*
 * The callback service for NFSv4.1 callbacks
 */
static int
nfs41_callback_svc(void *vrqstp)
{
	struct svc_rqst *rqstp = vrqstp;
	struct svc_serv *serv = rqstp->rq_server;
	struct rpc_rqst *req;
	int error;
	DEFINE_WAIT(wq);

	set_freezable();

	while (!kthread_should_stop()) {
		prepare_to_wait(&serv->sv_cb_waitq, &wq, TASK_INTERRUPTIBLE);
		spin_lock_bh(&serv->sv_cb_lock);
		if (!list_empty(&serv->sv_cb_list)) {
			req = list_first_entry(&serv->sv_cb_list,
					struct rpc_rqst, rq_bc_list);
			list_del(&req->rq_bc_list);
			spin_unlock_bh(&serv->sv_cb_lock);
			dprintk("Invoking bc_svc_process()\n");
			error = bc_svc_process(serv, req, rqstp);
			dprintk("bc_svc_process() returned w/ error code= %d\n",
				error);
		} else {
			spin_unlock_bh(&serv->sv_cb_lock);
			schedule();
		}
		finish_wait(&serv->sv_cb_waitq, &wq);
	}
	return 0;
}

/*
 * Bring up the NFSv4.1 callback service
 */
162
static struct svc_rqst *
163
nfs41_callback_up(struct svc_serv *serv)
164
{
165
	struct svc_rqst *rqstp;
166

167 168 169
	INIT_LIST_HEAD(&serv->sv_cb_list);
	spin_lock_init(&serv->sv_cb_lock);
	init_waitqueue_head(&serv->sv_cb_waitq);
170
	rqstp = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
171
	if (IS_ERR(rqstp)) {
172 173
		svc_xprt_put(serv->sv_bc_xprt);
		serv->sv_bc_xprt = NULL;
174 175 176
	}
	dprintk("--> %s return %ld\n", __func__,
		IS_ERR(rqstp) ? PTR_ERR(rqstp) : 0);
177
	return rqstp;
178 179 180
}

static inline int nfs_minorversion_callback_svc_setup(u32 minorversion,
181
		struct svc_serv *serv,
182 183 184
		struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
{
	if (minorversion) {
185
		*rqstpp = nfs41_callback_up(serv);
186 187 188 189 190 191
		*callback_svc = nfs41_callback_svc;
	}
	return minorversion;
}

static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
192
		struct svc_serv *serv)
193 194
{
	if (minorversion)
195 196 197 198 199
		/*
		 * Save the svc_serv in the transport so that it can
		 * be referenced when the session backchannel is initialized
		 */
		xprt->bc_serv = serv;
200 201
}
#else
202 203 204 205 206
static int nfs41_callback_up_net(struct svc_serv *serv, struct net *net)
{
	return 0;
}

207
static inline int nfs_minorversion_callback_svc_setup(u32 minorversion,
208
		struct svc_serv *serv,
209 210 211 212 213 214
		struct svc_rqst **rqstpp, int (**callback_svc)(void *vrqstp))
{
	return 0;
}

static inline void nfs_callback_bc_serv(u32 minorversion, struct rpc_xprt *xprt,
215
		struct svc_serv *serv)
216 217 218 219
{
}
#endif /* CONFIG_NFS_V4_1 */

220 221 222 223 224 225 226 227 228 229 230 231
static int nfs_callback_start_svc(int minorversion, struct rpc_xprt *xprt,
				  struct svc_serv *serv)
{
	struct svc_rqst *rqstp;
	int (*callback_svc)(void *vrqstp);
	struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
	char svc_name[12];
	int ret;
	int minorversion_setup;

	nfs_callback_bc_serv(minorversion, xprt, serv);

232 233 234
	if (cb_info->task)
		return 0;

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
	minorversion_setup =  nfs_minorversion_callback_svc_setup(minorversion,
					serv, &rqstp, &callback_svc);
	if (!minorversion_setup) {
		/* v4.0 callback setup */
		rqstp = nfs4_callback_up(serv);
		callback_svc = nfs4_callback_svc;
	}

	if (IS_ERR(rqstp))
		return PTR_ERR(rqstp);

	svc_sock_update_bufs(serv);

	sprintf(svc_name, "nfsv4.%u-svc", minorversion);
	cb_info->serv = serv;
	cb_info->rqst = rqstp;
	cb_info->task = kthread_run(callback_svc, cb_info->rqst, svc_name);
	if (IS_ERR(cb_info->task)) {
		ret = PTR_ERR(cb_info->task);
		svc_exit_thread(cb_info->rqst);
		cb_info->rqst = NULL;
		cb_info->task = NULL;
		return PTR_ERR(cb_info->task);
	}
	dprintk("nfs_callback_up: service started\n");
	return 0;
}

263 264 265 266 267 268 269 270 271 272 273
static void nfs_callback_down_net(u32 minorversion, struct svc_serv *serv, struct net *net)
{
	struct nfs_net *nn = net_generic(net, nfs_net_id);

	if (--nn->cb_users[minorversion])
		return;

	dprintk("NFS: destroy per-net callback data; net=%p\n", net);
	svc_shutdown_net(serv, net);
}

274 275
static int nfs_callback_up_net(int minorversion, struct svc_serv *serv, struct net *net)
{
276
	struct nfs_net *nn = net_generic(net, nfs_net_id);
277 278
	int ret;

279 280 281
	if (nn->cb_users[minorversion]++)
		return 0;

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
	dprintk("NFS: create per-net callback data; net=%p\n", net);

	ret = svc_bind(serv, net);
	if (ret < 0) {
		printk(KERN_WARNING "NFS: bind callback service failed\n");
		goto err_bind;
	}

	switch (minorversion) {
		case 0:
			ret = nfs4_callback_up_net(serv, net);
			break;
		case 1:
			ret = nfs41_callback_up_net(serv, net);
			break;
		default:
			printk(KERN_ERR "NFS: unknown callback version: %d\n",
					minorversion);
			ret = -EINVAL;
			break;
	}

	if (ret < 0) {
		printk(KERN_ERR "NFS: callback service start failed\n");
		goto err_socks;
	}
	return 0;

err_socks:
	svc_rpcb_cleanup(serv, net);
err_bind:
313 314
	dprintk("NFS: Couldn't create callback socket: err = %d; "
			"net = %p\n", ret, net);
315 316 317
	return ret;
}

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
static struct svc_serv *nfs_callback_create_svc(int minorversion)
{
	struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
	struct svc_serv *serv;

	/*
	 * Check whether we're already up and running.
	 */
	if (cb_info->task) {
		/*
		 * Note: increase service usage, because later in case of error
		 * svc_destroy() will be called.
		 */
		svc_get(cb_info->serv);
		return cb_info->serv;
	}

	/*
	 * Sanity check: if there's no task,
	 * we should be the first user ...
	 */
	if (cb_info->users)
		printk(KERN_WARNING "nfs_callback_create_svc: no kthread, %d users??\n",
			cb_info->users);

	serv = svc_create(&nfs4_callback_program, NFS4_CALLBACK_BUFSIZE, NULL);
	if (!serv) {
		printk(KERN_ERR "nfs_callback_create_svc: create service failed\n");
		return ERR_PTR(-ENOMEM);
	}
	/* As there is only one thread we need to over-ride the
	 * default maximum of 80 connections
	 */
	serv->sv_maxconn = 1024;
	dprintk("nfs_callback_create_svc: service created\n");
	return serv;
}

356 357 358 359 360
/*
 * Bring up the callback thread if it is not already up.
 */
int nfs_callback_up(u32 minorversion, struct rpc_xprt *xprt)
{
361
	struct svc_serv *serv;
362
	struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];
363
	int ret;
364
	struct net *net = xprt->xprt_net;
365 366

	mutex_lock(&nfs_callback_mutex);
367 368 369 370 371 372 373

	serv = nfs_callback_create_svc(minorversion);
	if (IS_ERR(serv)) {
		ret = PTR_ERR(serv);
		goto err_create;
	}

374 375 376
	ret = nfs_callback_up_net(minorversion, serv, net);
	if (ret < 0)
		goto err_net;
377

378 379 380
	ret = nfs_callback_start_svc(minorversion, xprt, serv);
	if (ret < 0)
		goto err_start;
381

382
	cb_info->users++;
383 384
	/*
	 * svc_create creates the svc_serv with sv_nrthreads == 1, and then
385
	 * svc_prepare_thread increments that. So we need to call svc_destroy
386 387 388
	 * on both success and failure so that the refcount is 1 when the
	 * thread exits.
	 */
389
err_net:
390 391
	svc_destroy(serv);
err_create:
I
Ingo Molnar 已提交
392
	mutex_unlock(&nfs_callback_mutex);
L
Linus Torvalds 已提交
393
	return ret;
394 395

err_start:
396
	nfs_callback_down_net(minorversion, serv, net);
397 398
	dprintk("NFS: Couldn't create server thread; err = %d\n", ret);
	goto err_net;
L
Linus Torvalds 已提交
399 400 401
}

/*
402
 * Kill the callback thread if it's no longer being used.
L
Linus Torvalds 已提交
403
 */
404
void nfs_callback_down(int minorversion, struct net *net)
L
Linus Torvalds 已提交
405
{
406 407
	struct nfs_callback_data *cb_info = &nfs_callback_info[minorversion];

I
Ingo Molnar 已提交
408
	mutex_lock(&nfs_callback_mutex);
409
	nfs_callback_down_net(minorversion, cb_info->serv, net);
410 411 412
	cb_info->users--;
	if (cb_info->users == 0 && cb_info->task != NULL) {
		kthread_stop(cb_info->task);
413
		dprintk("nfs_callback_down: service stopped\n");
414
		svc_exit_thread(cb_info->rqst);
415
		dprintk("nfs_callback_down: service destroyed\n");
416 417 418
		cb_info->serv = NULL;
		cb_info->rqst = NULL;
		cb_info->task = NULL;
419
	}
I
Ingo Molnar 已提交
420
	mutex_unlock(&nfs_callback_mutex);
L
Linus Torvalds 已提交
421 422
}

423 424 425
/* Boolean check of RPC_AUTH_GSS principal */
int
check_gss_callback_principal(struct nfs_client *clp, struct svc_rqst *rqstp)
426
{
427
	char *p = rqstp->rq_cred.cr_principal;
428

429 430 431
	if (rqstp->rq_authop->flavour != RPC_AUTH_GSS)
		return 1;

432 433
	/* No RPC_AUTH_GSS on NFSv4.1 back channel yet */
	if (clp->cl_minorversion != 0)
434
		return 0;
435 436 437 438 439
	/*
	 * It might just be a normal user principal, in which case
	 * userspace won't bother to tell us the name at all.
	 */
	if (p == NULL)
440
		return 0;
441 442 443 444

	/* Expect a GSS_C_NT_HOSTBASED_NAME like "nfs@serverhostname" */

	if (memcmp(p, "nfs@", 4) != 0)
445
		return 0;
446
	p += 4;
447
	if (strcmp(p, clp->cl_hostname) != 0)
448 449
		return 0;
	return 1;
450 451
}

452 453 454 455 456 457 458 459 460
/*
 * pg_authenticate method for nfsv4 callback threads.
 *
 * The authflavor has been negotiated, so an incorrect flavor is a server
 * bug. Drop packets with incorrect authflavor.
 *
 * All other checking done after NFS decoding where the nfs_client can be
 * found in nfs4_callback_compound
 */
L
Linus Torvalds 已提交
461 462 463
static int nfs_callback_authenticate(struct svc_rqst *rqstp)
{
	switch (rqstp->rq_authop->flavour) {
464 465 466 467 468 469 470 471
	case RPC_AUTH_NULL:
		if (rqstp->rq_proc != CB_NULL)
			return SVC_DROP;
		break;
	case RPC_AUTH_GSS:
		/* No RPC_AUTH_GSS support yet in NFSv4.1 */
		 if (svc_is_backchannel(rqstp))
			return SVC_DROP;
L
Linus Torvalds 已提交
472
	}
473
	return SVC_OK;
L
Linus Torvalds 已提交
474 475 476 477 478 479 480
}

/*
 * Define NFS4 callback program
 */
static struct svc_version *nfs4_callback_version[] = {
	[1] = &nfs4_callback_version1,
481
	[4] = &nfs4_callback_version4,
L
Linus Torvalds 已提交
482 483 484 485 486 487 488 489 490 491 492 493 494
};

static struct svc_stat nfs4_callback_stats;

static struct svc_program nfs4_callback_program = {
	.pg_prog = NFS4_CALLBACK,			/* RPC service number */
	.pg_nvers = ARRAY_SIZE(nfs4_callback_version),	/* Number of entries */
	.pg_vers = nfs4_callback_version,		/* version table */
	.pg_name = "NFSv4 callback",			/* service name */
	.pg_class = "nfs",				/* authentication class */
	.pg_stats = &nfs4_callback_stats,
	.pg_authenticate = nfs_callback_authenticate,
};