mon.c 14.8 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10
/*
 * linux/fs/lockd/mon.c
 *
 * The kernel statd client.
 *
 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
 */

#include <linux/types.h>
#include <linux/kernel.h>
11
#include <linux/ktime.h>
12
#include <linux/slab.h>
13

L
Linus Torvalds 已提交
14
#include <linux/sunrpc/clnt.h>
15
#include <linux/sunrpc/xprtsock.h>
L
Linus Torvalds 已提交
16 17 18
#include <linux/sunrpc/svc.h>
#include <linux/lockd/lockd.h>

19 20
#include <asm/unaligned.h>

21 22
#include "netns.h"

L
Linus Torvalds 已提交
23
#define NLMDBG_FACILITY		NLMDBG_MONITOR
24 25 26 27 28 29 30 31 32 33 34 35
#define NSM_PROGRAM		100024
#define NSM_VERSION		1

enum {
	NSMPROC_NULL,
	NSMPROC_STAT,
	NSMPROC_MON,
	NSMPROC_UNMON,
	NSMPROC_UNMON_ALL,
	NSMPROC_SIMU_CRASH,
	NSMPROC_NOTIFY,
};
L
Linus Torvalds 已提交
36

37
struct nsm_args {
38
	struct nsm_private	*priv;
39 40 41 42 43
	u32			prog;		/* RPC callback info */
	u32			vers;
	u32			proc;

	char			*mon_name;
44
	char			*nodename;
45 46 47 48 49 50 51
};

struct nsm_res {
	u32			status;
	u32			state;
};

52
static const struct rpc_program	nsm_program;
53 54
static				LIST_HEAD(nsm_handles);
static				DEFINE_SPINLOCK(nsm_lock);
L
Linus Torvalds 已提交
55 56 57 58

/*
 * Local NSM state
 */
59
u32	__read_mostly		nsm_local_state;
60
bool	__read_mostly		nsm_use_hostnames;
L
Linus Torvalds 已提交
61

62 63 64 65 66
static inline struct sockaddr *nsm_addr(const struct nsm_handle *nsm)
{
	return (struct sockaddr *)&nsm->sm_addr;
}

67
static struct rpc_clnt *nsm_create(struct net *net)
C
Chuck Lever 已提交
68 69 70 71 72 73
{
	struct sockaddr_in sin = {
		.sin_family		= AF_INET,
		.sin_addr.s_addr	= htonl(INADDR_LOOPBACK),
	};
	struct rpc_create_args args = {
74
		.net			= net,
75
		.protocol		= XPRT_TRANSPORT_TCP,
C
Chuck Lever 已提交
76 77 78 79 80 81
		.address		= (struct sockaddr *)&sin,
		.addrsize		= sizeof(sin),
		.servername		= "rpc.statd",
		.program		= &nsm_program,
		.version		= NSM_VERSION,
		.authflavor		= RPC_AUTH_NULL,
82
		.flags			= RPC_CLNT_CREATE_NOPING,
C
Chuck Lever 已提交
83 84 85 86 87
	};

	return rpc_create(&args);
}

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
static struct rpc_clnt *nsm_client_set(struct lockd_net *ln,
		struct rpc_clnt *clnt)
{
	spin_lock(&ln->nsm_clnt_lock);
	if (ln->nsm_users == 0) {
		if (clnt == NULL)
			goto out;
		ln->nsm_clnt = clnt;
	}
	clnt = ln->nsm_clnt;
	ln->nsm_users++;
out:
	spin_unlock(&ln->nsm_clnt_lock);
	return clnt;
}

104
static struct rpc_clnt *nsm_client_get(struct net *net)
105
{
106
	struct rpc_clnt	*clnt, *new;
107 108
	struct lockd_net *ln = net_generic(net, lockd_net_id);

109 110
	clnt = nsm_client_set(ln, NULL);
	if (clnt != NULL)
111 112
		goto out;

113 114 115 116 117 118 119
	clnt = new = nsm_create(net);
	if (IS_ERR(clnt))
		goto out;

	clnt = nsm_client_set(ln, new);
	if (clnt != new)
		rpc_shutdown_client(new);
120 121 122 123
out:
	return clnt;
}

124
static void nsm_client_put(struct net *net)
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
{
	struct lockd_net *ln = net_generic(net, lockd_net_id);
	struct rpc_clnt	*clnt = ln->nsm_clnt;
	int shutdown = 0;

	spin_lock(&ln->nsm_clnt_lock);
	if (ln->nsm_users) {
		if (--ln->nsm_users)
			ln->nsm_clnt = NULL;
		shutdown = !ln->nsm_users;
	}
	spin_unlock(&ln->nsm_clnt_lock);

	if (shutdown)
		rpc_shutdown_client(clnt);
}

142
static int nsm_mon_unmon(struct nsm_handle *nsm, u32 proc, struct nsm_res *res,
143
			 struct rpc_clnt *clnt)
L
Linus Torvalds 已提交
144 145
{
	int		status;
146
	struct nsm_args args = {
147
		.priv		= &nsm->sm_priv,
148 149 150
		.prog		= NLM_PROGRAM,
		.vers		= 3,
		.proc		= NLMPROC_NSM_NOTIFY,
151
		.mon_name	= nsm->sm_mon_name,
152
		.nodename	= clnt->cl_nodename,
153
	};
154 155 156 157
	struct rpc_message msg = {
		.rpc_argp	= &args,
		.rpc_resp	= res,
	};
L
Linus Torvalds 已提交
158

159
	BUG_ON(clnt == NULL);
L
Linus Torvalds 已提交
160 161 162

	memset(res, 0, sizeof(*res));

163
	msg.rpc_proc = &clnt->cl_procinfo[proc];
164
	status = rpc_call_sync(clnt, &msg, RPC_TASK_SOFTCONN);
L
Linus Torvalds 已提交
165
	if (status < 0)
166 167
		dprintk("lockd: NSM upcall RPC failed, status=%d\n",
				status);
L
Linus Torvalds 已提交
168 169 170 171 172
	else
		status = 0;
	return status;
}

173 174 175 176 177 178 179 180 181 182
/**
 * nsm_monitor - Notify a peer in case we reboot
 * @host: pointer to nlm_host of peer to notify
 *
 * If this peer is not already monitored, this function sends an
 * upcall to the local rpc.statd to record the name/address of
 * the peer to notify in case we reboot.
 *
 * Returns zero if the peer is monitored by the local rpc.statd;
 * otherwise a negative errno value is returned.
L
Linus Torvalds 已提交
183
 */
184
int nsm_monitor(const struct nlm_host *host)
L
Linus Torvalds 已提交
185
{
186
	struct nsm_handle *nsm = host->h_nsmhandle;
L
Linus Torvalds 已提交
187 188
	struct nsm_res	res;
	int		status;
189
	struct rpc_clnt *clnt;
L
Linus Torvalds 已提交
190

191
	dprintk("lockd: nsm_monitor(%s)\n", nsm->sm_name);
192 193

	if (nsm->sm_monitored)
194
		return 0;
L
Linus Torvalds 已提交
195

196 197 198 199 200 201
	/*
	 * Choose whether to record the caller_name or IP address of
	 * this peer in the local rpc.statd's database.
	 */
	nsm->sm_mon_name = nsm_use_hostnames ? nsm->sm_name : nsm->sm_addrbuf;

202 203 204 205 206 207 208 209 210
	clnt = nsm_client_get(host->net);
	if (IS_ERR(clnt)) {
		status = PTR_ERR(clnt);
		dprintk("lockd: failed to create NSM upcall transport, "
				"status=%d, net=%p\n", status, host->net);
		return status;
	}

	status = nsm_mon_unmon(nsm, NSMPROC_MON, &res, clnt);
211
	if (unlikely(res.status != 0))
212
		status = -EIO;
213
	if (unlikely(status < 0)) {
214
		printk(KERN_NOTICE "lockd: cannot monitor %s\n", nsm->sm_name);
215 216 217 218 219 220 221 222 223
		return status;
	}

	nsm->sm_monitored = 1;
	if (unlikely(nsm_local_state != res.state)) {
		nsm_local_state = res.state;
		dprintk("lockd: NSM state changed to %d\n", nsm_local_state);
	}
	return 0;
L
Linus Torvalds 已提交
224 225
}

226 227 228 229 230 231 232
/**
 * nsm_unmonitor - Unregister peer notification
 * @host: pointer to nlm_host of peer to stop monitoring
 *
 * If this peer is monitored, this function sends an upcall to
 * tell the local rpc.statd not to send this peer a notification
 * when we reboot.
L
Linus Torvalds 已提交
233
 */
234
void nsm_unmonitor(const struct nlm_host *host)
L
Linus Torvalds 已提交
235
{
236
	struct nsm_handle *nsm = host->h_nsmhandle;
L
Linus Torvalds 已提交
237
	struct nsm_res	res;
238
	int status;
L
Linus Torvalds 已提交
239

240 241
	if (atomic_read(&nsm->sm_count) == 1
	 && nsm->sm_monitored && !nsm->sm_sticky) {
242 243
		struct lockd_net *ln = net_generic(host->net, lockd_net_id);

244
		dprintk("lockd: nsm_unmonitor(%s)\n", nsm->sm_name);
245

246
		status = nsm_mon_unmon(nsm, NSMPROC_UNMON, &res, ln->nsm_clnt);
247 248
		if (res.status != 0)
			status = -EIO;
249
		if (status < 0)
250
			printk(KERN_NOTICE "lockd: cannot unmonitor %s\n",
251
					nsm->sm_name);
252 253
		else
			nsm->sm_monitored = 0;
254 255

		nsm_client_put(host->net);
256
	}
L
Linus Torvalds 已提交
257 258
}

259 260 261 262 263 264 265 266 267 268 269 270
static struct nsm_handle *nsm_lookup_hostname(const char *hostname,
					      const size_t len)
{
	struct nsm_handle *nsm;

	list_for_each_entry(nsm, &nsm_handles, sm_link)
		if (strlen(nsm->sm_name) == len &&
		    memcmp(nsm->sm_name, hostname, len) == 0)
			return nsm;
	return NULL;
}

271 272 273 274 275
static struct nsm_handle *nsm_lookup_addr(const struct sockaddr *sap)
{
	struct nsm_handle *nsm;

	list_for_each_entry(nsm, &nsm_handles, sm_link)
276
		if (rpc_cmp_addr(nsm_addr(nsm), sap))
277 278 279 280
			return nsm;
	return NULL;
}

281 282 283 284 285 286 287 288 289 290 291
static struct nsm_handle *nsm_lookup_priv(const struct nsm_private *priv)
{
	struct nsm_handle *nsm;

	list_for_each_entry(nsm, &nsm_handles, sm_link)
		if (memcmp(nsm->sm_priv.data, priv->data,
					sizeof(priv->data)) == 0)
			return nsm;
	return NULL;
}

292 293 294 295 296 297
/*
 * Construct a unique cookie to match this nsm_handle to this monitored
 * host.  It is passed to the local rpc.statd via NSMPROC_MON, and
 * returned via NLMPROC_SM_NOTIFY, in the "priv" field of these
 * requests.
 *
298 299 300 301 302 303 304 305 306 307
 * The NSM protocol requires that these cookies be unique while the
 * system is running.  We prefer a stronger requirement of making them
 * unique across reboots.  If user space bugs cause a stale cookie to
 * be sent to the kernel, it could cause the wrong host to lose its
 * lock state if cookies were not unique across reboots.
 *
 * The cookies are exposed only to local user space via loopback.  They
 * do not appear on the physical network.  If we want greater security
 * for some reason, nsm_init_private() could perform a one-way hash to
 * obscure the contents of the cookie.
308 309 310
 */
static void nsm_init_private(struct nsm_handle *nsm)
{
311 312
	u64 *p = (u64 *)&nsm->sm_priv.data;
	struct timespec ts;
313
	s64 ns;
314 315

	ktime_get_ts(&ts);
316 317 318
	ns = timespec_to_ns(&ts);
	put_unaligned(ns, p);
	put_unaligned((unsigned long)nsm, p + 1);
319 320
}

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
static struct nsm_handle *nsm_create_handle(const struct sockaddr *sap,
					    const size_t salen,
					    const char *hostname,
					    const size_t hostname_len)
{
	struct nsm_handle *new;

	new = kzalloc(sizeof(*new) + hostname_len + 1, GFP_KERNEL);
	if (unlikely(new == NULL))
		return NULL;

	atomic_set(&new->sm_count, 1);
	new->sm_name = (char *)(new + 1);
	memcpy(nsm_addr(new), sap, salen);
	new->sm_addrlen = salen;
	nsm_init_private(new);
337 338 339 340 341

	if (rpc_ntop(nsm_addr(new), new->sm_addrbuf,
					sizeof(new->sm_addrbuf)) == 0)
		(void)snprintf(new->sm_addrbuf, sizeof(new->sm_addrbuf),
				"unsupported address family");
342 343 344 345 346 347
	memcpy(new->sm_name, hostname, hostname_len);
	new->sm_name[hostname_len] = '\0';

	return new;
}

348
/**
349
 * nsm_get_handle - Find or create a cached nsm_handle
350 351 352 353 354
 * @sap: pointer to socket address of handle to find
 * @salen: length of socket address
 * @hostname: pointer to C string containing hostname to find
 * @hostname_len: length of C string
 *
355
 * Behavior is modulated by the global nsm_use_hostnames variable.
356
 *
357 358 359 360
 * Returns a cached nsm_handle after bumping its ref count, or
 * returns a fresh nsm_handle if a handle that matches @sap and/or
 * @hostname cannot be found in the handle cache.  Returns NULL if
 * an error occurs.
361
 */
362 363 364
struct nsm_handle *nsm_get_handle(const struct sockaddr *sap,
				  const size_t salen, const char *hostname,
				  const size_t hostname_len)
365
{
366
	struct nsm_handle *cached, *new = NULL;
367 368 369 370 371 372 373 374 375 376 377 378

	if (hostname && memchr(hostname, '/', hostname_len) != NULL) {
		if (printk_ratelimit()) {
			printk(KERN_WARNING "Invalid hostname \"%.*s\" "
					    "in NFS lock request\n",
				(int)hostname_len, hostname);
		}
		return NULL;
	}

retry:
	spin_lock(&nsm_lock);
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393

	if (nsm_use_hostnames && hostname != NULL)
		cached = nsm_lookup_hostname(hostname, hostname_len);
	else
		cached = nsm_lookup_addr(sap);

	if (cached != NULL) {
		atomic_inc(&cached->sm_count);
		spin_unlock(&nsm_lock);
		kfree(new);
		dprintk("lockd: found nsm_handle for %s (%s), "
				"cnt %d\n", cached->sm_name,
				cached->sm_addrbuf,
				atomic_read(&cached->sm_count));
		return cached;
394
	}
395 396 397 398

	if (new != NULL) {
		list_add(&new->sm_link, &nsm_handles);
		spin_unlock(&nsm_lock);
399
		dprintk("lockd: created nsm_handle for %s (%s)\n",
400 401
				new->sm_name, new->sm_addrbuf);
		return new;
402
	}
403

404 405
	spin_unlock(&nsm_lock);

406 407
	new = nsm_create_handle(sap, salen, hostname, hostname_len);
	if (unlikely(new == NULL))
408 409 410 411
		return NULL;
	goto retry;
}

412 413 414 415
/**
 * nsm_reboot_lookup - match NLMPROC_SM_NOTIFY arguments to an nsm_handle
 * @info: pointer to NLMPROC_SM_NOTIFY arguments
 *
416 417 418
 * Returns a matching nsm_handle if found in the nsm cache. The returned
 * nsm_handle's reference count is bumped. Otherwise returns NULL if some
 * error occurred.
419 420 421 422 423 424 425
 */
struct nsm_handle *nsm_reboot_lookup(const struct nlm_reboot *info)
{
	struct nsm_handle *cached;

	spin_lock(&nsm_lock);

426
	cached = nsm_lookup_priv(&info->priv);
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
	if (unlikely(cached == NULL)) {
		spin_unlock(&nsm_lock);
		dprintk("lockd: never saw rebooted peer '%.*s' before\n",
				info->len, info->mon);
		return cached;
	}

	atomic_inc(&cached->sm_count);
	spin_unlock(&nsm_lock);

	dprintk("lockd: host %s (%s) rebooted, cnt %d\n",
			cached->sm_name, cached->sm_addrbuf,
			atomic_read(&cached->sm_count));
	return cached;
}

443 444 445 446 447 448 449 450 451 452
/**
 * nsm_release - Release an NSM handle
 * @nsm: pointer to handle to be released
 *
 */
void nsm_release(struct nsm_handle *nsm)
{
	if (atomic_dec_and_lock(&nsm->sm_count, &nsm_lock)) {
		list_del(&nsm->sm_link);
		spin_unlock(&nsm_lock);
453 454
		dprintk("lockd: destroyed nsm_handle for %s (%s)\n",
				nsm->sm_name, nsm->sm_addrbuf);
455 456 457 458
		kfree(nsm);
	}
}

L
Linus Torvalds 已提交
459 460
/*
 * XDR functions for NSM.
461 462 463
 *
 * See http://www.opengroup.org/ for details on the Network
 * Status Monitor wire protocol.
L
Linus Torvalds 已提交
464 465
 */

466
static void encode_nsm_string(struct xdr_stream *xdr, const char *string)
467
{
468 469 470
	const u32 len = strlen(string);
	__be32 *p;

471 472
	BUG_ON(len > SM_MAXSTRLEN);
	p = xdr_reserve_space(xdr, 4 + len);
473
	xdr_encode_opaque(p, string, len);
474 475
}

476 477 478
/*
 * "mon_name" specifies the host to be monitored.
 */
479
static void encode_mon_name(struct xdr_stream *xdr, const struct nsm_args *argp)
480
{
481
	encode_nsm_string(xdr, argp->mon_name);
482 483
}

484 485 486
/*
 * The "my_id" argument specifies the hostname and RPC procedure
 * to be called when the status manager receives notification
487
 * (via the NLMPROC_SM_NOTIFY call) that the state of host "mon_name"
488 489
 * has changed.
 */
490
static void encode_my_id(struct xdr_stream *xdr, const struct nsm_args *argp)
491
{
492 493
	__be32 *p;

494
	encode_nsm_string(xdr, argp->nodename);
495 496 497 498
	p = xdr_reserve_space(xdr, 4 + 4 + 4);
	*p++ = cpu_to_be32(argp->prog);
	*p++ = cpu_to_be32(argp->vers);
	*p = cpu_to_be32(argp->proc);
499 500
}

501 502
/*
 * The "mon_id" argument specifies the non-private arguments
503
 * of an NSMPROC_MON or NSMPROC_UNMON call.
504
 */
505
static void encode_mon_id(struct xdr_stream *xdr, const struct nsm_args *argp)
506
{
507 508
	encode_mon_name(xdr, argp);
	encode_my_id(xdr, argp);
509 510
}

511 512
/*
 * The "priv" argument may contain private information required
513 514
 * by the NSMPROC_MON call. This information will be supplied in the
 * NLMPROC_SM_NOTIFY call.
515
 */
516
static void encode_priv(struct xdr_stream *xdr, const struct nsm_args *argp)
517
{
518 519 520
	__be32 *p;

	p = xdr_reserve_space(xdr, SM_PRIV_SIZE);
521
	xdr_encode_opaque_fixed(p, argp->priv->data, SM_PRIV_SIZE);
522 523
}

524 525
static void nsm_xdr_enc_mon(struct rpc_rqst *req, struct xdr_stream *xdr,
			    const struct nsm_args *argp)
L
Linus Torvalds 已提交
526
{
527 528
	encode_mon_id(xdr, argp);
	encode_priv(xdr, argp);
L
Linus Torvalds 已提交
529 530
}

531 532
static void nsm_xdr_enc_unmon(struct rpc_rqst *req, struct xdr_stream *xdr,
			      const struct nsm_args *argp)
L
Linus Torvalds 已提交
533
{
534
	encode_mon_id(xdr, argp);
L
Linus Torvalds 已提交
535 536
}

537 538 539
static int nsm_xdr_dec_stat_res(struct rpc_rqst *rqstp,
				struct xdr_stream *xdr,
				struct nsm_res *resp)
L
Linus Torvalds 已提交
540
{
541
	__be32 *p;
542

543
	p = xdr_inline_decode(xdr, 4 + 4);
544 545
	if (unlikely(p == NULL))
		return -EIO;
546 547
	resp->status = be32_to_cpup(p++);
	resp->state = be32_to_cpup(p);
548

549 550
	dprintk("lockd: %s status %d state %d\n",
		__func__, resp->status, resp->state);
L
Linus Torvalds 已提交
551 552 553
	return 0;
}

554 555 556
static int nsm_xdr_dec_stat(struct rpc_rqst *rqstp,
			    struct xdr_stream *xdr,
			    struct nsm_res *resp)
L
Linus Torvalds 已提交
557
{
558
	__be32 *p;
559

560
	p = xdr_inline_decode(xdr, 4);
561 562
	if (unlikely(p == NULL))
		return -EIO;
563
	resp->state = be32_to_cpup(p);
564

565
	dprintk("lockd: %s state %d\n", __func__, resp->state);
L
Linus Torvalds 已提交
566 567 568 569
	return 0;
}

#define SM_my_name_sz	(1+XDR_QUADLEN(SM_MAXSTRLEN))
570 571 572
#define SM_my_id_sz	(SM_my_name_sz+3)
#define SM_mon_name_sz	(1+XDR_QUADLEN(SM_MAXSTRLEN))
#define SM_mon_id_sz	(SM_mon_name_sz+SM_my_id_sz)
573 574
#define SM_priv_sz	(XDR_QUADLEN(SM_PRIV_SIZE))
#define SM_mon_sz	(SM_mon_id_sz+SM_priv_sz)
L
Linus Torvalds 已提交
575 576 577 578
#define SM_monres_sz	2
#define SM_unmonres_sz	1

static struct rpc_procinfo	nsm_procedures[] = {
579 580
[NSMPROC_MON] = {
		.p_proc		= NSMPROC_MON,
581
		.p_encode	= (kxdreproc_t)nsm_xdr_enc_mon,
582
		.p_decode	= (kxdrdproc_t)nsm_xdr_dec_stat_res,
583 584
		.p_arglen	= SM_mon_sz,
		.p_replen	= SM_monres_sz,
585
		.p_statidx	= NSMPROC_MON,
586
		.p_name		= "MONITOR",
L
Linus Torvalds 已提交
587
	},
588 589
[NSMPROC_UNMON] = {
		.p_proc		= NSMPROC_UNMON,
590
		.p_encode	= (kxdreproc_t)nsm_xdr_enc_unmon,
591
		.p_decode	= (kxdrdproc_t)nsm_xdr_dec_stat,
592 593
		.p_arglen	= SM_mon_id_sz,
		.p_replen	= SM_unmonres_sz,
594
		.p_statidx	= NSMPROC_UNMON,
595
		.p_name		= "UNMONITOR",
L
Linus Torvalds 已提交
596 597 598
	},
};

599
static const struct rpc_version nsm_version1 = {
600 601
		.number		= 1,
		.nrprocs	= ARRAY_SIZE(nsm_procedures),
L
Linus Torvalds 已提交
602 603 604
		.procs		= nsm_procedures
};

605
static const struct rpc_version *nsm_version[] = {
L
Linus Torvalds 已提交
606 607 608 609 610
	[1] = &nsm_version1,
};

static struct rpc_stat		nsm_stats;

611
static const struct rpc_program nsm_program = {
L
Linus Torvalds 已提交
612
		.name		= "statd",
613
		.number		= NSM_PROGRAM,
614
		.nrvers		= ARRAY_SIZE(nsm_version),
L
Linus Torvalds 已提交
615 616 617
		.version	= nsm_version,
		.stats		= &nsm_stats
};
新手
引导
客服 返回
顶部