amd64_edac: bump driver version
[linux/fpc-iii.git] / fs / lockd / mon.c
blobf956651d0f651a66a00d4bb9a1d05febf761d524
1 /*
2 * linux/fs/lockd/mon.c
4 * The kernel statd client.
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
7 */
9 #include <linux/types.h>
10 #include <linux/utsname.h>
11 #include <linux/kernel.h>
12 #include <linux/ktime.h>
14 #include <linux/sunrpc/clnt.h>
15 #include <linux/sunrpc/xprtsock.h>
16 #include <linux/sunrpc/svc.h>
17 #include <linux/lockd/lockd.h>
19 #include <asm/unaligned.h>
21 #define NLMDBG_FACILITY NLMDBG_MONITOR
22 #define NSM_PROGRAM 100024
23 #define NSM_VERSION 1
25 enum {
26 NSMPROC_NULL,
27 NSMPROC_STAT,
28 NSMPROC_MON,
29 NSMPROC_UNMON,
30 NSMPROC_UNMON_ALL,
31 NSMPROC_SIMU_CRASH,
32 NSMPROC_NOTIFY,
35 struct nsm_args {
36 struct nsm_private *priv;
37 u32 prog; /* RPC callback info */
38 u32 vers;
39 u32 proc;
41 char *mon_name;
44 struct nsm_res {
45 u32 status;
46 u32 state;
49 static struct rpc_program nsm_program;
50 static LIST_HEAD(nsm_handles);
51 static DEFINE_SPINLOCK(nsm_lock);
54 * Local NSM state
56 u32 __read_mostly nsm_local_state;
57 int __read_mostly nsm_use_hostnames;
59 static inline struct sockaddr *nsm_addr(const struct nsm_handle *nsm)
61 return (struct sockaddr *)&nsm->sm_addr;
64 static struct rpc_clnt *nsm_create(void)
66 struct sockaddr_in sin = {
67 .sin_family = AF_INET,
68 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
70 struct rpc_create_args args = {
71 .protocol = XPRT_TRANSPORT_UDP,
72 .address = (struct sockaddr *)&sin,
73 .addrsize = sizeof(sin),
74 .servername = "rpc.statd",
75 .program = &nsm_program,
76 .version = NSM_VERSION,
77 .authflavor = RPC_AUTH_NULL,
78 .flags = RPC_CLNT_CREATE_NOPING,
81 return rpc_create(&args);
84 static int nsm_mon_unmon(struct nsm_handle *nsm, u32 proc, struct nsm_res *res)
86 struct rpc_clnt *clnt;
87 int status;
88 struct nsm_args args = {
89 .priv = &nsm->sm_priv,
90 .prog = NLM_PROGRAM,
91 .vers = 3,
92 .proc = NLMPROC_NSM_NOTIFY,
93 .mon_name = nsm->sm_mon_name,
95 struct rpc_message msg = {
96 .rpc_argp = &args,
97 .rpc_resp = res,
100 clnt = nsm_create();
101 if (IS_ERR(clnt)) {
102 status = PTR_ERR(clnt);
103 dprintk("lockd: failed to create NSM upcall transport, "
104 "status=%d\n", status);
105 goto out;
108 memset(res, 0, sizeof(*res));
110 msg.rpc_proc = &clnt->cl_procinfo[proc];
111 status = rpc_call_sync(clnt, &msg, 0);
112 if (status < 0)
113 dprintk("lockd: NSM upcall RPC failed, status=%d\n",
114 status);
115 else
116 status = 0;
117 rpc_shutdown_client(clnt);
118 out:
119 return status;
123 * nsm_monitor - Notify a peer in case we reboot
124 * @host: pointer to nlm_host of peer to notify
126 * If this peer is not already monitored, this function sends an
127 * upcall to the local rpc.statd to record the name/address of
128 * the peer to notify in case we reboot.
130 * Returns zero if the peer is monitored by the local rpc.statd;
131 * otherwise a negative errno value is returned.
133 int nsm_monitor(const struct nlm_host *host)
135 struct nsm_handle *nsm = host->h_nsmhandle;
136 struct nsm_res res;
137 int status;
139 dprintk("lockd: nsm_monitor(%s)\n", nsm->sm_name);
141 if (nsm->sm_monitored)
142 return 0;
145 * Choose whether to record the caller_name or IP address of
146 * this peer in the local rpc.statd's database.
148 nsm->sm_mon_name = nsm_use_hostnames ? nsm->sm_name : nsm->sm_addrbuf;
150 status = nsm_mon_unmon(nsm, NSMPROC_MON, &res);
151 if (unlikely(res.status != 0))
152 status = -EIO;
153 if (unlikely(status < 0)) {
154 printk(KERN_NOTICE "lockd: cannot monitor %s\n", nsm->sm_name);
155 return status;
158 nsm->sm_monitored = 1;
159 if (unlikely(nsm_local_state != res.state)) {
160 nsm_local_state = res.state;
161 dprintk("lockd: NSM state changed to %d\n", nsm_local_state);
163 return 0;
167 * nsm_unmonitor - Unregister peer notification
168 * @host: pointer to nlm_host of peer to stop monitoring
170 * If this peer is monitored, this function sends an upcall to
171 * tell the local rpc.statd not to send this peer a notification
172 * when we reboot.
174 void nsm_unmonitor(const struct nlm_host *host)
176 struct nsm_handle *nsm = host->h_nsmhandle;
177 struct nsm_res res;
178 int status;
180 if (atomic_read(&nsm->sm_count) == 1
181 && nsm->sm_monitored && !nsm->sm_sticky) {
182 dprintk("lockd: nsm_unmonitor(%s)\n", nsm->sm_name);
184 status = nsm_mon_unmon(nsm, NSMPROC_UNMON, &res);
185 if (res.status != 0)
186 status = -EIO;
187 if (status < 0)
188 printk(KERN_NOTICE "lockd: cannot unmonitor %s\n",
189 nsm->sm_name);
190 else
191 nsm->sm_monitored = 0;
195 static struct nsm_handle *nsm_lookup_hostname(const char *hostname,
196 const size_t len)
198 struct nsm_handle *nsm;
200 list_for_each_entry(nsm, &nsm_handles, sm_link)
201 if (strlen(nsm->sm_name) == len &&
202 memcmp(nsm->sm_name, hostname, len) == 0)
203 return nsm;
204 return NULL;
207 static struct nsm_handle *nsm_lookup_addr(const struct sockaddr *sap)
209 struct nsm_handle *nsm;
211 list_for_each_entry(nsm, &nsm_handles, sm_link)
212 if (rpc_cmp_addr(nsm_addr(nsm), sap))
213 return nsm;
214 return NULL;
217 static struct nsm_handle *nsm_lookup_priv(const struct nsm_private *priv)
219 struct nsm_handle *nsm;
221 list_for_each_entry(nsm, &nsm_handles, sm_link)
222 if (memcmp(nsm->sm_priv.data, priv->data,
223 sizeof(priv->data)) == 0)
224 return nsm;
225 return NULL;
229 * Construct a unique cookie to match this nsm_handle to this monitored
230 * host. It is passed to the local rpc.statd via NSMPROC_MON, and
231 * returned via NLMPROC_SM_NOTIFY, in the "priv" field of these
232 * requests.
234 * The NSM protocol requires that these cookies be unique while the
235 * system is running. We prefer a stronger requirement of making them
236 * unique across reboots. If user space bugs cause a stale cookie to
237 * be sent to the kernel, it could cause the wrong host to lose its
238 * lock state if cookies were not unique across reboots.
240 * The cookies are exposed only to local user space via loopback. They
241 * do not appear on the physical network. If we want greater security
242 * for some reason, nsm_init_private() could perform a one-way hash to
243 * obscure the contents of the cookie.
245 static void nsm_init_private(struct nsm_handle *nsm)
247 u64 *p = (u64 *)&nsm->sm_priv.data;
248 struct timespec ts;
249 s64 ns;
251 ktime_get_ts(&ts);
252 ns = timespec_to_ns(&ts);
253 put_unaligned(ns, p);
254 put_unaligned((unsigned long)nsm, p + 1);
257 static struct nsm_handle *nsm_create_handle(const struct sockaddr *sap,
258 const size_t salen,
259 const char *hostname,
260 const size_t hostname_len)
262 struct nsm_handle *new;
264 new = kzalloc(sizeof(*new) + hostname_len + 1, GFP_KERNEL);
265 if (unlikely(new == NULL))
266 return NULL;
268 atomic_set(&new->sm_count, 1);
269 new->sm_name = (char *)(new + 1);
270 memcpy(nsm_addr(new), sap, salen);
271 new->sm_addrlen = salen;
272 nsm_init_private(new);
274 if (rpc_ntop(nsm_addr(new), new->sm_addrbuf,
275 sizeof(new->sm_addrbuf)) == 0)
276 (void)snprintf(new->sm_addrbuf, sizeof(new->sm_addrbuf),
277 "unsupported address family");
278 memcpy(new->sm_name, hostname, hostname_len);
279 new->sm_name[hostname_len] = '\0';
281 return new;
285 * nsm_get_handle - Find or create a cached nsm_handle
286 * @sap: pointer to socket address of handle to find
287 * @salen: length of socket address
288 * @hostname: pointer to C string containing hostname to find
289 * @hostname_len: length of C string
291 * Behavior is modulated by the global nsm_use_hostnames variable.
293 * Returns a cached nsm_handle after bumping its ref count, or
294 * returns a fresh nsm_handle if a handle that matches @sap and/or
295 * @hostname cannot be found in the handle cache. Returns NULL if
296 * an error occurs.
298 struct nsm_handle *nsm_get_handle(const struct sockaddr *sap,
299 const size_t salen, const char *hostname,
300 const size_t hostname_len)
302 struct nsm_handle *cached, *new = NULL;
304 if (hostname && memchr(hostname, '/', hostname_len) != NULL) {
305 if (printk_ratelimit()) {
306 printk(KERN_WARNING "Invalid hostname \"%.*s\" "
307 "in NFS lock request\n",
308 (int)hostname_len, hostname);
310 return NULL;
313 retry:
314 spin_lock(&nsm_lock);
316 if (nsm_use_hostnames && hostname != NULL)
317 cached = nsm_lookup_hostname(hostname, hostname_len);
318 else
319 cached = nsm_lookup_addr(sap);
321 if (cached != NULL) {
322 atomic_inc(&cached->sm_count);
323 spin_unlock(&nsm_lock);
324 kfree(new);
325 dprintk("lockd: found nsm_handle for %s (%s), "
326 "cnt %d\n", cached->sm_name,
327 cached->sm_addrbuf,
328 atomic_read(&cached->sm_count));
329 return cached;
332 if (new != NULL) {
333 list_add(&new->sm_link, &nsm_handles);
334 spin_unlock(&nsm_lock);
335 dprintk("lockd: created nsm_handle for %s (%s)\n",
336 new->sm_name, new->sm_addrbuf);
337 return new;
340 spin_unlock(&nsm_lock);
342 new = nsm_create_handle(sap, salen, hostname, hostname_len);
343 if (unlikely(new == NULL))
344 return NULL;
345 goto retry;
349 * nsm_reboot_lookup - match NLMPROC_SM_NOTIFY arguments to an nsm_handle
350 * @info: pointer to NLMPROC_SM_NOTIFY arguments
352 * Returns a matching nsm_handle if found in the nsm cache; the returned
353 * nsm_handle's reference count is bumped and sm_monitored is cleared.
354 * Otherwise returns NULL if some error occurred.
356 struct nsm_handle *nsm_reboot_lookup(const struct nlm_reboot *info)
358 struct nsm_handle *cached;
360 spin_lock(&nsm_lock);
362 cached = nsm_lookup_priv(&info->priv);
363 if (unlikely(cached == NULL)) {
364 spin_unlock(&nsm_lock);
365 dprintk("lockd: never saw rebooted peer '%.*s' before\n",
366 info->len, info->mon);
367 return cached;
370 atomic_inc(&cached->sm_count);
371 spin_unlock(&nsm_lock);
374 * During subsequent lock activity, force a fresh
375 * notification to be set up for this host.
377 cached->sm_monitored = 0;
379 dprintk("lockd: host %s (%s) rebooted, cnt %d\n",
380 cached->sm_name, cached->sm_addrbuf,
381 atomic_read(&cached->sm_count));
382 return cached;
386 * nsm_release - Release an NSM handle
387 * @nsm: pointer to handle to be released
390 void nsm_release(struct nsm_handle *nsm)
392 if (atomic_dec_and_lock(&nsm->sm_count, &nsm_lock)) {
393 list_del(&nsm->sm_link);
394 spin_unlock(&nsm_lock);
395 dprintk("lockd: destroyed nsm_handle for %s (%s)\n",
396 nsm->sm_name, nsm->sm_addrbuf);
397 kfree(nsm);
402 * XDR functions for NSM.
404 * See http://www.opengroup.org/ for details on the Network
405 * Status Monitor wire protocol.
408 static int encode_nsm_string(struct xdr_stream *xdr, const char *string)
410 const u32 len = strlen(string);
411 __be32 *p;
413 if (unlikely(len > SM_MAXSTRLEN))
414 return -EIO;
415 p = xdr_reserve_space(xdr, sizeof(u32) + len);
416 if (unlikely(p == NULL))
417 return -EIO;
418 xdr_encode_opaque(p, string, len);
419 return 0;
423 * "mon_name" specifies the host to be monitored.
425 static int encode_mon_name(struct xdr_stream *xdr, const struct nsm_args *argp)
427 return encode_nsm_string(xdr, argp->mon_name);
431 * The "my_id" argument specifies the hostname and RPC procedure
432 * to be called when the status manager receives notification
433 * (via the NLMPROC_SM_NOTIFY call) that the state of host "mon_name"
434 * has changed.
436 static int encode_my_id(struct xdr_stream *xdr, const struct nsm_args *argp)
438 int status;
439 __be32 *p;
441 status = encode_nsm_string(xdr, utsname()->nodename);
442 if (unlikely(status != 0))
443 return status;
444 p = xdr_reserve_space(xdr, 3 * sizeof(u32));
445 if (unlikely(p == NULL))
446 return -EIO;
447 *p++ = htonl(argp->prog);
448 *p++ = htonl(argp->vers);
449 *p++ = htonl(argp->proc);
450 return 0;
454 * The "mon_id" argument specifies the non-private arguments
455 * of an NSMPROC_MON or NSMPROC_UNMON call.
457 static int encode_mon_id(struct xdr_stream *xdr, const struct nsm_args *argp)
459 int status;
461 status = encode_mon_name(xdr, argp);
462 if (unlikely(status != 0))
463 return status;
464 return encode_my_id(xdr, argp);
468 * The "priv" argument may contain private information required
469 * by the NSMPROC_MON call. This information will be supplied in the
470 * NLMPROC_SM_NOTIFY call.
472 static int encode_priv(struct xdr_stream *xdr, const struct nsm_args *argp)
474 __be32 *p;
476 p = xdr_reserve_space(xdr, SM_PRIV_SIZE);
477 if (unlikely(p == NULL))
478 return -EIO;
479 xdr_encode_opaque_fixed(p, argp->priv->data, SM_PRIV_SIZE);
480 return 0;
483 static int xdr_enc_mon(struct rpc_rqst *req, __be32 *p,
484 const struct nsm_args *argp)
486 struct xdr_stream xdr;
487 int status;
489 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
490 status = encode_mon_id(&xdr, argp);
491 if (unlikely(status))
492 return status;
493 return encode_priv(&xdr, argp);
496 static int xdr_enc_unmon(struct rpc_rqst *req, __be32 *p,
497 const struct nsm_args *argp)
499 struct xdr_stream xdr;
501 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
502 return encode_mon_id(&xdr, argp);
505 static int xdr_dec_stat_res(struct rpc_rqst *rqstp, __be32 *p,
506 struct nsm_res *resp)
508 struct xdr_stream xdr;
510 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
511 p = xdr_inline_decode(&xdr, 2 * sizeof(u32));
512 if (unlikely(p == NULL))
513 return -EIO;
514 resp->status = ntohl(*p++);
515 resp->state = ntohl(*p);
517 dprintk("lockd: xdr_dec_stat_res status %d state %d\n",
518 resp->status, resp->state);
519 return 0;
522 static int xdr_dec_stat(struct rpc_rqst *rqstp, __be32 *p,
523 struct nsm_res *resp)
525 struct xdr_stream xdr;
527 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
528 p = xdr_inline_decode(&xdr, sizeof(u32));
529 if (unlikely(p == NULL))
530 return -EIO;
531 resp->state = ntohl(*p);
533 dprintk("lockd: xdr_dec_stat state %d\n", resp->state);
534 return 0;
537 #define SM_my_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
538 #define SM_my_id_sz (SM_my_name_sz+3)
539 #define SM_mon_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
540 #define SM_mon_id_sz (SM_mon_name_sz+SM_my_id_sz)
541 #define SM_priv_sz (XDR_QUADLEN(SM_PRIV_SIZE))
542 #define SM_mon_sz (SM_mon_id_sz+SM_priv_sz)
543 #define SM_monres_sz 2
544 #define SM_unmonres_sz 1
546 static struct rpc_procinfo nsm_procedures[] = {
547 [NSMPROC_MON] = {
548 .p_proc = NSMPROC_MON,
549 .p_encode = (kxdrproc_t)xdr_enc_mon,
550 .p_decode = (kxdrproc_t)xdr_dec_stat_res,
551 .p_arglen = SM_mon_sz,
552 .p_replen = SM_monres_sz,
553 .p_statidx = NSMPROC_MON,
554 .p_name = "MONITOR",
556 [NSMPROC_UNMON] = {
557 .p_proc = NSMPROC_UNMON,
558 .p_encode = (kxdrproc_t)xdr_enc_unmon,
559 .p_decode = (kxdrproc_t)xdr_dec_stat,
560 .p_arglen = SM_mon_id_sz,
561 .p_replen = SM_unmonres_sz,
562 .p_statidx = NSMPROC_UNMON,
563 .p_name = "UNMONITOR",
567 static struct rpc_version nsm_version1 = {
568 .number = 1,
569 .nrprocs = ARRAY_SIZE(nsm_procedures),
570 .procs = nsm_procedures
573 static struct rpc_version * nsm_version[] = {
574 [1] = &nsm_version1,
577 static struct rpc_stat nsm_stats;
579 static struct rpc_program nsm_program = {
580 .name = "statd",
581 .number = NSM_PROGRAM,
582 .nrvers = ARRAY_SIZE(nsm_version),
583 .version = nsm_version,
584 .stats = &nsm_stats