NSM: Generate NSMPROC_MON's "priv" argument when nsm_handle is created
[linux-2.6.git] / fs / lockd / mon.c
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>
13 #include <linux/sunrpc/xprtsock.h>
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
20 #define NSM_PROGRAM             100024
21 #define NSM_VERSION             1
22
23 enum {
24         NSMPROC_NULL,
25         NSMPROC_STAT,
26         NSMPROC_MON,
27         NSMPROC_UNMON,
28         NSMPROC_UNMON_ALL,
29         NSMPROC_SIMU_CRASH,
30         NSMPROC_NOTIFY,
31 };
32
33 struct 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
42 struct nsm_res {
43         u32                     status;
44         u32                     state;
45 };
46
47 static struct rpc_clnt *        nsm_create(void);
48
49 static struct rpc_program       nsm_program;
50 static                          LIST_HEAD(nsm_handles);
51 static                          DEFINE_SPINLOCK(nsm_lock);
52
53 /*
54  * Local NSM state
55  */
56 int                             nsm_local_state;
57
58 static 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
65 static 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
79 static 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
95 /*
96  * Common procedure for NSMPROC_MON/NSMPROC_UNMON calls
97  */
98 static int
99 nsm_mon_unmon(struct nsm_handle *nsm, u32 proc, struct nsm_res *res)
100 {
101         struct rpc_clnt *clnt;
102         int             status;
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,
108                 .mon_name       = nsm->sm_mon_name,
109         };
110         struct rpc_message msg = {
111                 .rpc_argp       = &args,
112                 .rpc_resp       = res,
113         };
114
115         clnt = nsm_create();
116         if (IS_ERR(clnt)) {
117                 status = PTR_ERR(clnt);
118                 dprintk("lockd: failed to create NSM upcall transport, "
119                                 "status=%d\n", status);
120                 goto out;
121         }
122
123         memset(res, 0, sizeof(*res));
124
125         msg.rpc_proc = &clnt->cl_procinfo[proc];
126         status = rpc_call_sync(clnt, &msg, 0);
127         if (status < 0)
128                 dprintk("lockd: NSM upcall RPC failed, status=%d\n",
129                                 status);
130         else
131                 status = 0;
132         rpc_shutdown_client(clnt);
133  out:
134         return status;
135 }
136
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.
147  */
148 int nsm_monitor(const struct nlm_host *host)
149 {
150         struct nsm_handle *nsm = host->h_nsmhandle;
151         struct nsm_res  res;
152         int             status;
153
154         dprintk("lockd: nsm_monitor(%s)\n", nsm->sm_name);
155
156         if (nsm->sm_monitored)
157                 return 0;
158
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
165         status = nsm_mon_unmon(nsm, NSMPROC_MON, &res);
166         if (res.status != 0)
167                 status = -EIO;
168         if (status < 0)
169                 printk(KERN_NOTICE "lockd: cannot monitor %s\n", nsm->sm_name);
170         else
171                 nsm->sm_monitored = 1;
172         return status;
173 }
174
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.
182  */
183 void nsm_unmonitor(const struct nlm_host *host)
184 {
185         struct nsm_handle *nsm = host->h_nsmhandle;
186         struct nsm_res  res;
187         int status;
188
189         if (atomic_read(&nsm->sm_count) == 1
190          && nsm->sm_monitored && !nsm->sm_sticky) {
191                 dprintk("lockd: nsm_unmonitor(%s)\n", nsm->sm_name);
192
193                 status = nsm_mon_unmon(nsm, NSMPROC_UNMON, &res);
194                 if (res.status != 0)
195                         status = -EIO;
196                 if (status < 0)
197                         printk(KERN_NOTICE "lockd: cannot unmonitor %s\n",
198                                         nsm->sm_name);
199                 else
200                         nsm->sm_monitored = 0;
201         }
202 }
203
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  */
213 static 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
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  */
235 struct 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
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
251 retry:
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;
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));
267                 goto found;
268         }
269         if (nsm) {
270                 list_add(&nsm->sm_link, &nsm_handles);
271                 dprintk("lockd: created nsm_handle for %s (%s)\n",
272                                 nsm->sm_name, nsm->sm_addrbuf);
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';
289         nsm_init_private(nsm);
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
295 found:
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  */
305 void nsm_release(struct nsm_handle *nsm)
306 {
307         if (atomic_dec_and_lock(&nsm->sm_count, &nsm_lock)) {
308                 list_del(&nsm->sm_link);
309                 spin_unlock(&nsm_lock);
310                 dprintk("lockd: destroyed nsm_handle for %s (%s)\n",
311                                 nsm->sm_name, nsm->sm_addrbuf);
312                 kfree(nsm);
313         }
314 }
315
316 /*
317  * Create NSM client for the local host
318  */
319 static struct rpc_clnt *
320 nsm_create(void)
321 {
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 = {
328                 .protocol       = XPRT_TRANSPORT_UDP,
329                 .address        = (struct sockaddr *)&sin,
330                 .addrsize       = sizeof(sin),
331                 .servername     = "localhost",
332                 .program        = &nsm_program,
333                 .version        = NSM_VERSION,
334                 .authflavor     = RPC_AUTH_NULL,
335         };
336
337         return rpc_create(&args);
338 }
339
340 /*
341  * XDR functions for NSM.
342  *
343  * See http://www.opengroup.org/ for details on the Network
344  * Status Monitor wire protocol.
345  */
346
347 static int encode_nsm_string(struct xdr_stream *xdr, const char *string)
348 {
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;
359 }
360
361 /*
362  * "mon_name" specifies the host to be monitored.
363  */
364 static int encode_mon_name(struct xdr_stream *xdr, const struct nsm_args *argp)
365 {
366         return encode_nsm_string(xdr, argp->mon_name);
367 }
368
369 /*
370  * The "my_id" argument specifies the hostname and RPC procedure
371  * to be called when the status manager receives notification
372  * (via the NLMPROC_SM_NOTIFY call) that the state of host "mon_name"
373  * has changed.
374  */
375 static int encode_my_id(struct xdr_stream *xdr, const struct nsm_args *argp)
376 {
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;
386         *p++ = htonl(argp->prog);
387         *p++ = htonl(argp->vers);
388         *p++ = htonl(argp->proc);
389         return 0;
390 }
391
392 /*
393  * The "mon_id" argument specifies the non-private arguments
394  * of an NSMPROC_MON or NSMPROC_UNMON call.
395  */
396 static int encode_mon_id(struct xdr_stream *xdr, const struct nsm_args *argp)
397 {
398         int status;
399
400         status = encode_mon_name(xdr, argp);
401         if (unlikely(status != 0))
402                 return status;
403         return encode_my_id(xdr, argp);
404 }
405
406 /*
407  * The "priv" argument may contain private information required
408  * by the NSMPROC_MON call. This information will be supplied in the
409  * NLMPROC_SM_NOTIFY call.
410  *
411  * Linux provides the raw IP address of the monitored host,
412  * left in network byte order.
413  */
414 static int encode_priv(struct xdr_stream *xdr, const struct nsm_args *argp)
415 {
416         __be32 *p;
417
418         p = xdr_reserve_space(xdr, SM_PRIV_SIZE);
419         if (unlikely(p == NULL))
420                 return -EIO;
421         *p++ = argp->addr;
422         *p++ = 0;
423         *p++ = 0;
424         *p++ = 0;
425         return 0;
426 }
427
428 static int xdr_enc_mon(struct rpc_rqst *req, __be32 *p,
429                        const struct nsm_args *argp)
430 {
431         struct xdr_stream xdr;
432         int status;
433
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);
439 }
440
441 static int xdr_enc_unmon(struct rpc_rqst *req, __be32 *p,
442                          const struct nsm_args *argp)
443 {
444         struct xdr_stream xdr;
445
446         xdr_init_encode(&xdr, &req->rq_snd_buf, p);
447         return encode_mon_id(&xdr, argp);
448 }
449
450 static int xdr_dec_stat_res(struct rpc_rqst *rqstp, __be32 *p,
451                             struct nsm_res *resp)
452 {
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;
459         resp->status = ntohl(*p++);
460         resp->state = ntohl(*p);
461
462         dprintk("lockd: xdr_dec_stat_res status %d state %d\n",
463                         resp->status, resp->state);
464         return 0;
465 }
466
467 static int xdr_dec_stat(struct rpc_rqst *rqstp, __be32 *p,
468                         struct nsm_res *resp)
469 {
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);
479         return 0;
480 }
481
482 #define SM_my_name_sz   (1+XDR_QUADLEN(SM_MAXSTRLEN))
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)
486 #define SM_priv_sz      (XDR_QUADLEN(SM_PRIV_SIZE))
487 #define SM_mon_sz       (SM_mon_id_sz+SM_priv_sz)
488 #define SM_monres_sz    2
489 #define SM_unmonres_sz  1
490
491 static struct rpc_procinfo      nsm_procedures[] = {
492 [NSMPROC_MON] = {
493                 .p_proc         = NSMPROC_MON,
494                 .p_encode       = (kxdrproc_t)xdr_enc_mon,
495                 .p_decode       = (kxdrproc_t)xdr_dec_stat_res,
496                 .p_arglen       = SM_mon_sz,
497                 .p_replen       = SM_monres_sz,
498                 .p_statidx      = NSMPROC_MON,
499                 .p_name         = "MONITOR",
500         },
501 [NSMPROC_UNMON] = {
502                 .p_proc         = NSMPROC_UNMON,
503                 .p_encode       = (kxdrproc_t)xdr_enc_unmon,
504                 .p_decode       = (kxdrproc_t)xdr_dec_stat,
505                 .p_arglen       = SM_mon_id_sz,
506                 .p_replen       = SM_unmonres_sz,
507                 .p_statidx      = NSMPROC_UNMON,
508                 .p_name         = "UNMONITOR",
509         },
510 };
511
512 static struct rpc_version       nsm_version1 = {
513                 .number         = 1,
514                 .nrprocs        = ARRAY_SIZE(nsm_procedures),
515                 .procs          = nsm_procedures
516 };
517
518 static struct rpc_version *     nsm_version[] = {
519         [1] = &nsm_version1,
520 };
521
522 static struct rpc_stat          nsm_stats;
523
524 static struct rpc_program       nsm_program = {
525                 .name           = "statd",
526                 .number         = NSM_PROGRAM,
527                 .nrvers         = ARRAY_SIZE(nsm_version),
528                 .version        = nsm_version,
529                 .stats          = &nsm_stats
530 };