NSM: Generate NSMPROC_MON's "priv" argument when nsm_handle is created
[linux-2.6-block.git] / fs / lockd / mon.c
CommitLineData
1da177e4
LT
1/*
2 * linux/fs/lockd/mon.c
3 *
4 * The kernel statd client.
5 *
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
7 */
8
9#include <linux/types.h>
10#include <linux/utsname.h>
11#include <linux/kernel.h>
12#include <linux/sunrpc/clnt.h>
0896a725 13#include <linux/sunrpc/xprtsock.h>
1da177e4
LT
14#include <linux/sunrpc/svc.h>
15#include <linux/lockd/lockd.h>
16#include <linux/lockd/sm_inter.h>
17
18
19#define NLMDBG_FACILITY NLMDBG_MONITOR
36e8e668
CL
20#define NSM_PROGRAM 100024
21#define NSM_VERSION 1
22
23enum {
24 NSMPROC_NULL,
25 NSMPROC_STAT,
26 NSMPROC_MON,
27 NSMPROC_UNMON,
28 NSMPROC_UNMON_ALL,
29 NSMPROC_SIMU_CRASH,
30 NSMPROC_NOTIFY,
31};
1da177e4 32
9c1bfd03
CL
33struct nsm_args {
34 __be32 addr; /* remote address */
35 u32 prog; /* RPC callback info */
36 u32 vers;
37 u32 proc;
38
39 char *mon_name;
40};
41
42struct nsm_res {
43 u32 status;
44 u32 state;
45};
46
1da177e4
LT
47static struct rpc_clnt * nsm_create(void);
48
49static struct rpc_program nsm_program;
67c6d107
CL
50static LIST_HEAD(nsm_handles);
51static DEFINE_SPINLOCK(nsm_lock);
1da177e4
LT
52
53/*
54 * Local NSM state
55 */
460f5cac 56int nsm_local_state;
1da177e4 57
67c6d107
CL
58static void nsm_display_ipv4_address(const struct sockaddr *sap, char *buf,
59 const size_t len)
60{
61 const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
62 snprintf(buf, len, "%pI4", &sin->sin_addr.s_addr);
63}
64
65static void nsm_display_ipv6_address(const struct sockaddr *sap, char *buf,
66 const size_t len)
67{
68 const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
69
70 if (ipv6_addr_v4mapped(&sin6->sin6_addr))
71 snprintf(buf, len, "%pI4", &sin6->sin6_addr.s6_addr32[3]);
72 else if (sin6->sin6_scope_id != 0)
73 snprintf(buf, len, "%pI6%%%u", &sin6->sin6_addr,
74 sin6->sin6_scope_id);
75 else
76 snprintf(buf, len, "%pI6", &sin6->sin6_addr);
77}
78
79static void nsm_display_address(const struct sockaddr *sap,
80 char *buf, const size_t len)
81{
82 switch (sap->sa_family) {
83 case AF_INET:
84 nsm_display_ipv4_address(sap, buf, len);
85 break;
86 case AF_INET6:
87 nsm_display_ipv6_address(sap, buf, len);
88 break;
89 default:
90 snprintf(buf, len, "unsupported address family");
91 break;
92 }
93}
94
1da177e4 95/*
36e8e668 96 * Common procedure for NSMPROC_MON/NSMPROC_UNMON calls
1da177e4
LT
97 */
98static int
9502c522 99nsm_mon_unmon(struct nsm_handle *nsm, u32 proc, struct nsm_res *res)
1da177e4
LT
100{
101 struct rpc_clnt *clnt;
102 int status;
a4846750
CL
103 struct nsm_args args = {
104 .addr = nsm_addr_in(nsm)->sin_addr.s_addr,
105 .prog = NLM_PROGRAM,
106 .vers = 3,
107 .proc = NLMPROC_NSM_NOTIFY,
29ed1407 108 .mon_name = nsm->sm_mon_name,
a4846750 109 };
dead28da
CL
110 struct rpc_message msg = {
111 .rpc_argp = &args,
112 .rpc_resp = res,
113 };
1da177e4
LT
114
115 clnt = nsm_create();
116 if (IS_ERR(clnt)) {
117 status = PTR_ERR(clnt);
5acf4315
CL
118 dprintk("lockd: failed to create NSM upcall transport, "
119 "status=%d\n", status);
1da177e4
LT
120 goto out;
121 }
122
1da177e4
LT
123 memset(res, 0, sizeof(*res));
124
dead28da
CL
125 msg.rpc_proc = &clnt->cl_procinfo[proc];
126 status = rpc_call_sync(clnt, &msg, 0);
1da177e4 127 if (status < 0)
5acf4315
CL
128 dprintk("lockd: NSM upcall RPC failed, status=%d\n",
129 status);
1da177e4
LT
130 else
131 status = 0;
90c5755f 132 rpc_shutdown_client(clnt);
1da177e4
LT
133 out:
134 return status;
135}
136
1e49323c
CL
137/**
138 * nsm_monitor - Notify a peer in case we reboot
139 * @host: pointer to nlm_host of peer to notify
140 *
141 * If this peer is not already monitored, this function sends an
142 * upcall to the local rpc.statd to record the name/address of
143 * the peer to notify in case we reboot.
144 *
145 * Returns zero if the peer is monitored by the local rpc.statd;
146 * otherwise a negative errno value is returned.
1da177e4 147 */
1e49323c 148int nsm_monitor(const struct nlm_host *host)
1da177e4 149{
8dead0db 150 struct nsm_handle *nsm = host->h_nsmhandle;
1da177e4
LT
151 struct nsm_res res;
152 int status;
153
9fee4902 154 dprintk("lockd: nsm_monitor(%s)\n", nsm->sm_name);
8dead0db
OK
155
156 if (nsm->sm_monitored)
977faf39 157 return 0;
1da177e4 158
29ed1407
CL
159 /*
160 * Choose whether to record the caller_name or IP address of
161 * this peer in the local rpc.statd's database.
162 */
163 nsm->sm_mon_name = nsm_use_hostnames ? nsm->sm_name : nsm->sm_addrbuf;
164
36e8e668 165 status = nsm_mon_unmon(nsm, NSMPROC_MON, &res);
5d254b11
CL
166 if (res.status != 0)
167 status = -EIO;
168 if (status < 0)
9fee4902 169 printk(KERN_NOTICE "lockd: cannot monitor %s\n", nsm->sm_name);
1da177e4 170 else
8dead0db 171 nsm->sm_monitored = 1;
1da177e4
LT
172 return status;
173}
174
356c3eb4
CL
175/**
176 * nsm_unmonitor - Unregister peer notification
177 * @host: pointer to nlm_host of peer to stop monitoring
178 *
179 * If this peer is monitored, this function sends an upcall to
180 * tell the local rpc.statd not to send this peer a notification
181 * when we reboot.
1da177e4 182 */
356c3eb4 183void nsm_unmonitor(const struct nlm_host *host)
1da177e4 184{
8dead0db 185 struct nsm_handle *nsm = host->h_nsmhandle;
1da177e4 186 struct nsm_res res;
356c3eb4 187 int status;
1da177e4 188
9502c522
OK
189 if (atomic_read(&nsm->sm_count) == 1
190 && nsm->sm_monitored && !nsm->sm_sticky) {
9fee4902 191 dprintk("lockd: nsm_unmonitor(%s)\n", nsm->sm_name);
9502c522 192
36e8e668 193 status = nsm_mon_unmon(nsm, NSMPROC_UNMON, &res);
0c7aef45
CL
194 if (res.status != 0)
195 status = -EIO;
977faf39 196 if (status < 0)
9502c522 197 printk(KERN_NOTICE "lockd: cannot unmonitor %s\n",
9fee4902 198 nsm->sm_name);
9502c522
OK
199 else
200 nsm->sm_monitored = 0;
977faf39 201 }
1da177e4
LT
202}
203
7e44d3be
CL
204/*
205 * Construct a unique cookie to match this nsm_handle to this monitored
206 * host. It is passed to the local rpc.statd via NSMPROC_MON, and
207 * returned via NLMPROC_SM_NOTIFY, in the "priv" field of these
208 * requests.
209 *
210 * Linux provides the raw IP address of the monitored host,
211 * left in network byte order.
212 */
213static void nsm_init_private(struct nsm_handle *nsm)
214{
215 __be32 *p = (__be32 *)&nsm->sm_priv.data;
216 *p = nsm_addr_in(nsm)->sin_addr.s_addr;
217}
218
67c6d107
CL
219/**
220 * nsm_find - Find or create a cached nsm_handle
221 * @sap: pointer to socket address of handle to find
222 * @salen: length of socket address
223 * @hostname: pointer to C string containing hostname to find
224 * @hostname_len: length of C string
225 * @create: one means create new handle if not found in cache
226 *
227 * Behavior is modulated by the global nsm_use_hostnames variable
228 * and by the @create argument.
229 *
230 * Returns a cached nsm_handle after bumping its ref count, or if
231 * @create is set, returns a fresh nsm_handle if a handle that
232 * matches @sap and/or @hostname cannot be found in the handle cache.
233 * Returns NULL if an error occurs.
234 */
235struct nsm_handle *nsm_find(const struct sockaddr *sap, const size_t salen,
236 const char *hostname, const size_t hostname_len,
237 const int create)
238{
239 struct nsm_handle *nsm = NULL;
240 struct nsm_handle *pos;
241
67c6d107
CL
242 if (hostname && memchr(hostname, '/', hostname_len) != NULL) {
243 if (printk_ratelimit()) {
244 printk(KERN_WARNING "Invalid hostname \"%.*s\" "
245 "in NFS lock request\n",
246 (int)hostname_len, hostname);
247 }
248 return NULL;
249 }
250
251retry:
252 spin_lock(&nsm_lock);
253 list_for_each_entry(pos, &nsm_handles, sm_link) {
254
255 if (hostname && nsm_use_hostnames) {
256 if (strlen(pos->sm_name) != hostname_len
257 || memcmp(pos->sm_name, hostname, hostname_len))
258 continue;
259 } else if (!nlm_cmp_addr(nsm_addr(pos), sap))
260 continue;
261 atomic_inc(&pos->sm_count);
262 kfree(nsm);
263 nsm = pos;
5cf1c4b1
CL
264 dprintk("lockd: found nsm_handle for %s (%s), cnt %d\n",
265 pos->sm_name, pos->sm_addrbuf,
266 atomic_read(&pos->sm_count));
67c6d107
CL
267 goto found;
268 }
269 if (nsm) {
270 list_add(&nsm->sm_link, &nsm_handles);
5cf1c4b1
CL
271 dprintk("lockd: created nsm_handle for %s (%s)\n",
272 nsm->sm_name, nsm->sm_addrbuf);
67c6d107
CL
273 goto found;
274 }
275 spin_unlock(&nsm_lock);
276
277 if (!create)
278 return NULL;
279
280 nsm = kzalloc(sizeof(*nsm) + hostname_len + 1, GFP_KERNEL);
281 if (nsm == NULL)
282 return NULL;
283
284 memcpy(nsm_addr(nsm), sap, salen);
285 nsm->sm_addrlen = salen;
286 nsm->sm_name = (char *) (nsm + 1);
287 memcpy(nsm->sm_name, hostname, hostname_len);
288 nsm->sm_name[hostname_len] = '\0';
7e44d3be 289 nsm_init_private(nsm);
67c6d107
CL
290 nsm_display_address((struct sockaddr *)&nsm->sm_addr,
291 nsm->sm_addrbuf, sizeof(nsm->sm_addrbuf));
292 atomic_set(&nsm->sm_count, 1);
293 goto retry;
294
295found:
296 spin_unlock(&nsm_lock);
297 return nsm;
298}
299
300/**
301 * nsm_release - Release an NSM handle
302 * @nsm: pointer to handle to be released
303 *
304 */
305void nsm_release(struct nsm_handle *nsm)
306{
67c6d107
CL
307 if (atomic_dec_and_lock(&nsm->sm_count, &nsm_lock)) {
308 list_del(&nsm->sm_link);
309 spin_unlock(&nsm_lock);
5cf1c4b1
CL
310 dprintk("lockd: destroyed nsm_handle for %s (%s)\n",
311 nsm->sm_name, nsm->sm_addrbuf);
67c6d107
CL
312 kfree(nsm);
313 }
314}
315
1da177e4
LT
316/*
317 * Create NSM client for the local host
318 */
319static struct rpc_clnt *
320nsm_create(void)
321{
e1ec7892
CL
322 struct sockaddr_in sin = {
323 .sin_family = AF_INET,
324 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
325 .sin_port = 0,
326 };
327 struct rpc_create_args args = {
0896a725 328 .protocol = XPRT_TRANSPORT_UDP,
e1ec7892
CL
329 .address = (struct sockaddr *)&sin,
330 .addrsize = sizeof(sin),
331 .servername = "localhost",
332 .program = &nsm_program,
36e8e668 333 .version = NSM_VERSION,
e1ec7892 334 .authflavor = RPC_AUTH_NULL,
e1ec7892
CL
335 };
336
337 return rpc_create(&args);
1da177e4
LT
338}
339
340/*
341 * XDR functions for NSM.
2ca7754d
CL
342 *
343 * See http://www.opengroup.org/ for details on the Network
344 * Status Monitor wire protocol.
1da177e4
LT
345 */
346
03eb1dcb 347static int encode_nsm_string(struct xdr_stream *xdr, const char *string)
099bd05f 348{
03eb1dcb
CL
349 const u32 len = strlen(string);
350 __be32 *p;
351
352 if (unlikely(len > SM_MAXSTRLEN))
353 return -EIO;
354 p = xdr_reserve_space(xdr, sizeof(u32) + len);
355 if (unlikely(p == NULL))
356 return -EIO;
357 xdr_encode_opaque(p, string, len);
358 return 0;
099bd05f
CL
359}
360
49695174
CL
361/*
362 * "mon_name" specifies the host to be monitored.
49695174 363 */
03eb1dcb 364static int encode_mon_name(struct xdr_stream *xdr, const struct nsm_args *argp)
49695174 365{
03eb1dcb 366 return encode_nsm_string(xdr, argp->mon_name);
49695174
CL
367}
368
850c95fd
CL
369/*
370 * The "my_id" argument specifies the hostname and RPC procedure
371 * to be called when the status manager receives notification
36e8e668 372 * (via the NLMPROC_SM_NOTIFY call) that the state of host "mon_name"
850c95fd
CL
373 * has changed.
374 */
03eb1dcb 375static int encode_my_id(struct xdr_stream *xdr, const struct nsm_args *argp)
850c95fd 376{
03eb1dcb
CL
377 int status;
378 __be32 *p;
379
380 status = encode_nsm_string(xdr, utsname()->nodename);
381 if (unlikely(status != 0))
382 return status;
383 p = xdr_reserve_space(xdr, 3 * sizeof(u32));
384 if (unlikely(p == NULL))
385 return -EIO;
850c95fd
CL
386 *p++ = htonl(argp->prog);
387 *p++ = htonl(argp->vers);
388 *p++ = htonl(argp->proc);
03eb1dcb 389 return 0;
850c95fd
CL
390}
391
ea72a7f1
CL
392/*
393 * The "mon_id" argument specifies the non-private arguments
36e8e668 394 * of an NSMPROC_MON or NSMPROC_UNMON call.
ea72a7f1 395 */
03eb1dcb 396static int encode_mon_id(struct xdr_stream *xdr, const struct nsm_args *argp)
ea72a7f1 397{
03eb1dcb 398 int status;
ea72a7f1 399
03eb1dcb
CL
400 status = encode_mon_name(xdr, argp);
401 if (unlikely(status != 0))
402 return status;
403 return encode_my_id(xdr, argp);
ea72a7f1
CL
404}
405
0490a54a
CL
406/*
407 * The "priv" argument may contain private information required
36e8e668
CL
408 * by the NSMPROC_MON call. This information will be supplied in the
409 * NLMPROC_SM_NOTIFY call.
0490a54a
CL
410 *
411 * Linux provides the raw IP address of the monitored host,
412 * left in network byte order.
413 */
03eb1dcb 414static int encode_priv(struct xdr_stream *xdr, const struct nsm_args *argp)
0490a54a 415{
03eb1dcb
CL
416 __be32 *p;
417
418 p = xdr_reserve_space(xdr, SM_PRIV_SIZE);
419 if (unlikely(p == NULL))
420 return -EIO;
0490a54a
CL
421 *p++ = argp->addr;
422 *p++ = 0;
423 *p++ = 0;
424 *p++ = 0;
03eb1dcb 425 return 0;
0490a54a
CL
426}
427
03eb1dcb
CL
428static int xdr_enc_mon(struct rpc_rqst *req, __be32 *p,
429 const struct nsm_args *argp)
1da177e4 430{
03eb1dcb
CL
431 struct xdr_stream xdr;
432 int status;
0490a54a 433
03eb1dcb
CL
434 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
435 status = encode_mon_id(&xdr, argp);
436 if (unlikely(status))
437 return status;
438 return encode_priv(&xdr, argp);
1da177e4
LT
439}
440
03eb1dcb
CL
441static int xdr_enc_unmon(struct rpc_rqst *req, __be32 *p,
442 const struct nsm_args *argp)
1da177e4 443{
03eb1dcb
CL
444 struct xdr_stream xdr;
445
446 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
447 return encode_mon_id(&xdr, argp);
1da177e4
LT
448}
449
03eb1dcb
CL
450static int xdr_dec_stat_res(struct rpc_rqst *rqstp, __be32 *p,
451 struct nsm_res *resp)
1da177e4 452{
03eb1dcb
CL
453 struct xdr_stream xdr;
454
455 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
456 p = xdr_inline_decode(&xdr, 2 * sizeof(u32));
457 if (unlikely(p == NULL))
458 return -EIO;
1da177e4 459 resp->status = ntohl(*p++);
03eb1dcb
CL
460 resp->state = ntohl(*p);
461
462 dprintk("lockd: xdr_dec_stat_res status %d state %d\n",
1da177e4
LT
463 resp->status, resp->state);
464 return 0;
465}
466
03eb1dcb
CL
467static int xdr_dec_stat(struct rpc_rqst *rqstp, __be32 *p,
468 struct nsm_res *resp)
1da177e4 469{
03eb1dcb
CL
470 struct xdr_stream xdr;
471
472 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
473 p = xdr_inline_decode(&xdr, sizeof(u32));
474 if (unlikely(p == NULL))
475 return -EIO;
476 resp->state = ntohl(*p);
477
478 dprintk("lockd: xdr_dec_stat state %d\n", resp->state);
1da177e4
LT
479 return 0;
480}
481
482#define SM_my_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
2ca7754d
CL
483#define SM_my_id_sz (SM_my_name_sz+3)
484#define SM_mon_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
485#define SM_mon_id_sz (SM_mon_name_sz+SM_my_id_sz)
0490a54a
CL
486#define SM_priv_sz (XDR_QUADLEN(SM_PRIV_SIZE))
487#define SM_mon_sz (SM_mon_id_sz+SM_priv_sz)
1da177e4
LT
488#define SM_monres_sz 2
489#define SM_unmonres_sz 1
490
1da177e4 491static struct rpc_procinfo nsm_procedures[] = {
36e8e668
CL
492[NSMPROC_MON] = {
493 .p_proc = NSMPROC_MON,
03eb1dcb
CL
494 .p_encode = (kxdrproc_t)xdr_enc_mon,
495 .p_decode = (kxdrproc_t)xdr_dec_stat_res,
2bea90d4
CL
496 .p_arglen = SM_mon_sz,
497 .p_replen = SM_monres_sz,
36e8e668 498 .p_statidx = NSMPROC_MON,
cc0175c1 499 .p_name = "MONITOR",
1da177e4 500 },
36e8e668
CL
501[NSMPROC_UNMON] = {
502 .p_proc = NSMPROC_UNMON,
03eb1dcb
CL
503 .p_encode = (kxdrproc_t)xdr_enc_unmon,
504 .p_decode = (kxdrproc_t)xdr_dec_stat,
2bea90d4
CL
505 .p_arglen = SM_mon_id_sz,
506 .p_replen = SM_unmonres_sz,
36e8e668 507 .p_statidx = NSMPROC_UNMON,
cc0175c1 508 .p_name = "UNMONITOR",
1da177e4
LT
509 },
510};
511
512static struct rpc_version nsm_version1 = {
e8c96f8c
TK
513 .number = 1,
514 .nrprocs = ARRAY_SIZE(nsm_procedures),
1da177e4
LT
515 .procs = nsm_procedures
516};
517
518static struct rpc_version * nsm_version[] = {
519 [1] = &nsm_version1,
520};
521
522static struct rpc_stat nsm_stats;
523
524static struct rpc_program nsm_program = {
525 .name = "statd",
36e8e668 526 .number = NSM_PROGRAM,
e8c96f8c 527 .nrvers = ARRAY_SIZE(nsm_version),
1da177e4
LT
528 .version = nsm_version,
529 .stats = &nsm_stats
530};