4 * The kernel statd client.
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
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>
19 #define NLMDBG_FACILITY NLMDBG_MONITOR
20 #define NSM_PROGRAM 100024
34 struct nsm_private *priv;
35 u32 prog; /* RPC callback info */
47 static struct rpc_clnt * nsm_create(void);
49 static struct rpc_program nsm_program;
50 static LIST_HEAD(nsm_handles);
51 static DEFINE_SPINLOCK(nsm_lock);
58 static void nsm_display_ipv4_address(const struct sockaddr *sap, char *buf,
61 const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
62 snprintf(buf, len, "%pI4", &sin->sin_addr.s_addr);
65 static void nsm_display_ipv6_address(const struct sockaddr *sap, char *buf,
68 const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
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,
76 snprintf(buf, len, "%pI6", &sin6->sin6_addr);
79 static void nsm_display_address(const struct sockaddr *sap,
80 char *buf, const size_t len)
82 switch (sap->sa_family) {
84 nsm_display_ipv4_address(sap, buf, len);
87 nsm_display_ipv6_address(sap, buf, len);
90 snprintf(buf, len, "unsupported address family");
96 * Common procedure for NSMPROC_MON/NSMPROC_UNMON calls
99 nsm_mon_unmon(struct nsm_handle *nsm, u32 proc, struct nsm_res *res)
101 struct rpc_clnt *clnt;
103 struct nsm_args args = {
104 .priv = &nsm->sm_priv,
107 .proc = NLMPROC_NSM_NOTIFY,
108 .mon_name = nsm->sm_mon_name,
110 struct rpc_message msg = {
117 status = PTR_ERR(clnt);
118 dprintk("lockd: failed to create NSM upcall transport, "
119 "status=%d\n", status);
123 memset(res, 0, sizeof(*res));
125 msg.rpc_proc = &clnt->cl_procinfo[proc];
126 status = rpc_call_sync(clnt, &msg, 0);
128 dprintk("lockd: NSM upcall RPC failed, status=%d\n",
132 rpc_shutdown_client(clnt);
138 * nsm_monitor - Notify a peer in case we reboot
139 * @host: pointer to nlm_host of peer to notify
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.
145 * Returns zero if the peer is monitored by the local rpc.statd;
146 * otherwise a negative errno value is returned.
148 int nsm_monitor(const struct nlm_host *host)
150 struct nsm_handle *nsm = host->h_nsmhandle;
154 dprintk("lockd: nsm_monitor(%s)\n", nsm->sm_name);
156 if (nsm->sm_monitored)
160 * Choose whether to record the caller_name or IP address of
161 * this peer in the local rpc.statd's database.
163 nsm->sm_mon_name = nsm_use_hostnames ? nsm->sm_name : nsm->sm_addrbuf;
165 status = nsm_mon_unmon(nsm, NSMPROC_MON, &res);
169 printk(KERN_NOTICE "lockd: cannot monitor %s\n", nsm->sm_name);
171 nsm->sm_monitored = 1;
176 * nsm_unmonitor - Unregister peer notification
177 * @host: pointer to nlm_host of peer to stop monitoring
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
183 void nsm_unmonitor(const struct nlm_host *host)
185 struct nsm_handle *nsm = host->h_nsmhandle;
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);
193 status = nsm_mon_unmon(nsm, NSMPROC_UNMON, &res);
197 printk(KERN_NOTICE "lockd: cannot unmonitor %s\n",
200 nsm->sm_monitored = 0;
204 static struct nsm_handle *nsm_lookup_hostname(const char *hostname,
207 struct nsm_handle *nsm;
209 list_for_each_entry(nsm, &nsm_handles, sm_link)
210 if (strlen(nsm->sm_name) == len &&
211 memcmp(nsm->sm_name, hostname, len) == 0)
216 static struct nsm_handle *nsm_lookup_priv(const struct nsm_private *priv)
218 struct nsm_handle *nsm;
220 list_for_each_entry(nsm, &nsm_handles, sm_link)
221 if (memcmp(nsm->sm_priv.data, priv->data,
222 sizeof(priv->data)) == 0)
228 * Construct a unique cookie to match this nsm_handle to this monitored
229 * host. It is passed to the local rpc.statd via NSMPROC_MON, and
230 * returned via NLMPROC_SM_NOTIFY, in the "priv" field of these
233 * Linux provides the raw IP address of the monitored host,
234 * left in network byte order.
236 static void nsm_init_private(struct nsm_handle *nsm)
238 __be32 *p = (__be32 *)&nsm->sm_priv.data;
239 *p = nsm_addr_in(nsm)->sin_addr.s_addr;
242 static struct nsm_handle *nsm_create_handle(const struct sockaddr *sap,
244 const char *hostname,
245 const size_t hostname_len)
247 struct nsm_handle *new;
249 new = kzalloc(sizeof(*new) + hostname_len + 1, GFP_KERNEL);
250 if (unlikely(new == NULL))
253 atomic_set(&new->sm_count, 1);
254 new->sm_name = (char *)(new + 1);
255 memcpy(nsm_addr(new), sap, salen);
256 new->sm_addrlen = salen;
257 nsm_init_private(new);
258 nsm_display_address((const struct sockaddr *)&new->sm_addr,
259 new->sm_addrbuf, sizeof(new->sm_addrbuf));
260 memcpy(new->sm_name, hostname, hostname_len);
261 new->sm_name[hostname_len] = '\0';
267 * nsm_get_handle - Find or create a cached nsm_handle
268 * @sap: pointer to socket address of handle to find
269 * @salen: length of socket address
270 * @hostname: pointer to C string containing hostname to find
271 * @hostname_len: length of C string
273 * Behavior is modulated by the global nsm_use_hostnames variable.
275 * Returns a cached nsm_handle after bumping its ref count, or
276 * returns a fresh nsm_handle if a handle that matches @sap and/or
277 * @hostname cannot be found in the handle cache. Returns NULL if
280 struct nsm_handle *nsm_get_handle(const struct sockaddr *sap,
281 const size_t salen, const char *hostname,
282 const size_t hostname_len)
284 struct nsm_handle *nsm = NULL;
285 struct nsm_handle *pos;
287 if (hostname && memchr(hostname, '/', hostname_len) != NULL) {
288 if (printk_ratelimit()) {
289 printk(KERN_WARNING "Invalid hostname \"%.*s\" "
290 "in NFS lock request\n",
291 (int)hostname_len, hostname);
297 spin_lock(&nsm_lock);
298 list_for_each_entry(pos, &nsm_handles, sm_link) {
300 if (hostname && nsm_use_hostnames) {
301 if (strlen(pos->sm_name) != hostname_len
302 || memcmp(pos->sm_name, hostname, hostname_len))
304 } else if (!nlm_cmp_addr(nsm_addr(pos), sap))
306 atomic_inc(&pos->sm_count);
309 dprintk("lockd: found nsm_handle for %s (%s), cnt %d\n",
310 pos->sm_name, pos->sm_addrbuf,
311 atomic_read(&pos->sm_count));
315 list_add(&nsm->sm_link, &nsm_handles);
316 dprintk("lockd: created nsm_handle for %s (%s)\n",
317 nsm->sm_name, nsm->sm_addrbuf);
320 spin_unlock(&nsm_lock);
322 nsm = nsm_create_handle(sap, salen, hostname, hostname_len);
323 if (unlikely(nsm == NULL))
328 spin_unlock(&nsm_lock);
333 * nsm_reboot_lookup - match NLMPROC_SM_NOTIFY arguments to an nsm_handle
334 * @info: pointer to NLMPROC_SM_NOTIFY arguments
336 * Returns a matching nsm_handle if found in the nsm cache; the returned
337 * nsm_handle's reference count is bumped and sm_monitored is cleared.
338 * Otherwise returns NULL if some error occurred.
340 struct nsm_handle *nsm_reboot_lookup(const struct nlm_reboot *info)
342 struct nsm_handle *cached;
344 spin_lock(&nsm_lock);
346 if (nsm_use_hostnames && info->mon != NULL)
347 cached = nsm_lookup_hostname(info->mon, info->len);
349 cached = nsm_lookup_priv(&info->priv);
351 if (unlikely(cached == NULL)) {
352 spin_unlock(&nsm_lock);
353 dprintk("lockd: never saw rebooted peer '%.*s' before\n",
354 info->len, info->mon);
358 atomic_inc(&cached->sm_count);
359 spin_unlock(&nsm_lock);
362 * During subsequent lock activity, force a fresh
363 * notification to be set up for this host.
365 cached->sm_monitored = 0;
367 dprintk("lockd: host %s (%s) rebooted, cnt %d\n",
368 cached->sm_name, cached->sm_addrbuf,
369 atomic_read(&cached->sm_count));
374 * nsm_release - Release an NSM handle
375 * @nsm: pointer to handle to be released
378 void nsm_release(struct nsm_handle *nsm)
380 if (atomic_dec_and_lock(&nsm->sm_count, &nsm_lock)) {
381 list_del(&nsm->sm_link);
382 spin_unlock(&nsm_lock);
383 dprintk("lockd: destroyed nsm_handle for %s (%s)\n",
384 nsm->sm_name, nsm->sm_addrbuf);
390 * Create NSM client for the local host
392 static struct rpc_clnt *
395 struct sockaddr_in sin = {
396 .sin_family = AF_INET,
397 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
400 struct rpc_create_args args = {
401 .protocol = XPRT_TRANSPORT_UDP,
402 .address = (struct sockaddr *)&sin,
403 .addrsize = sizeof(sin),
404 .servername = "localhost",
405 .program = &nsm_program,
406 .version = NSM_VERSION,
407 .authflavor = RPC_AUTH_NULL,
410 return rpc_create(&args);
414 * XDR functions for NSM.
416 * See http://www.opengroup.org/ for details on the Network
417 * Status Monitor wire protocol.
420 static int encode_nsm_string(struct xdr_stream *xdr, const char *string)
422 const u32 len = strlen(string);
425 if (unlikely(len > SM_MAXSTRLEN))
427 p = xdr_reserve_space(xdr, sizeof(u32) + len);
428 if (unlikely(p == NULL))
430 xdr_encode_opaque(p, string, len);
435 * "mon_name" specifies the host to be monitored.
437 static int encode_mon_name(struct xdr_stream *xdr, const struct nsm_args *argp)
439 return encode_nsm_string(xdr, argp->mon_name);
443 * The "my_id" argument specifies the hostname and RPC procedure
444 * to be called when the status manager receives notification
445 * (via the NLMPROC_SM_NOTIFY call) that the state of host "mon_name"
448 static int encode_my_id(struct xdr_stream *xdr, const struct nsm_args *argp)
453 status = encode_nsm_string(xdr, utsname()->nodename);
454 if (unlikely(status != 0))
456 p = xdr_reserve_space(xdr, 3 * sizeof(u32));
457 if (unlikely(p == NULL))
459 *p++ = htonl(argp->prog);
460 *p++ = htonl(argp->vers);
461 *p++ = htonl(argp->proc);
466 * The "mon_id" argument specifies the non-private arguments
467 * of an NSMPROC_MON or NSMPROC_UNMON call.
469 static int encode_mon_id(struct xdr_stream *xdr, const struct nsm_args *argp)
473 status = encode_mon_name(xdr, argp);
474 if (unlikely(status != 0))
476 return encode_my_id(xdr, argp);
480 * The "priv" argument may contain private information required
481 * by the NSMPROC_MON call. This information will be supplied in the
482 * NLMPROC_SM_NOTIFY call.
484 static int encode_priv(struct xdr_stream *xdr, const struct nsm_args *argp)
488 p = xdr_reserve_space(xdr, SM_PRIV_SIZE);
489 if (unlikely(p == NULL))
491 xdr_encode_opaque_fixed(p, argp->priv->data, SM_PRIV_SIZE);
495 static int xdr_enc_mon(struct rpc_rqst *req, __be32 *p,
496 const struct nsm_args *argp)
498 struct xdr_stream xdr;
501 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
502 status = encode_mon_id(&xdr, argp);
503 if (unlikely(status))
505 return encode_priv(&xdr, argp);
508 static int xdr_enc_unmon(struct rpc_rqst *req, __be32 *p,
509 const struct nsm_args *argp)
511 struct xdr_stream xdr;
513 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
514 return encode_mon_id(&xdr, argp);
517 static int xdr_dec_stat_res(struct rpc_rqst *rqstp, __be32 *p,
518 struct nsm_res *resp)
520 struct xdr_stream xdr;
522 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
523 p = xdr_inline_decode(&xdr, 2 * sizeof(u32));
524 if (unlikely(p == NULL))
526 resp->status = ntohl(*p++);
527 resp->state = ntohl(*p);
529 dprintk("lockd: xdr_dec_stat_res status %d state %d\n",
530 resp->status, resp->state);
534 static int xdr_dec_stat(struct rpc_rqst *rqstp, __be32 *p,
535 struct nsm_res *resp)
537 struct xdr_stream xdr;
539 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
540 p = xdr_inline_decode(&xdr, sizeof(u32));
541 if (unlikely(p == NULL))
543 resp->state = ntohl(*p);
545 dprintk("lockd: xdr_dec_stat state %d\n", resp->state);
549 #define SM_my_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
550 #define SM_my_id_sz (SM_my_name_sz+3)
551 #define SM_mon_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
552 #define SM_mon_id_sz (SM_mon_name_sz+SM_my_id_sz)
553 #define SM_priv_sz (XDR_QUADLEN(SM_PRIV_SIZE))
554 #define SM_mon_sz (SM_mon_id_sz+SM_priv_sz)
555 #define SM_monres_sz 2
556 #define SM_unmonres_sz 1
558 static struct rpc_procinfo nsm_procedures[] = {
560 .p_proc = NSMPROC_MON,
561 .p_encode = (kxdrproc_t)xdr_enc_mon,
562 .p_decode = (kxdrproc_t)xdr_dec_stat_res,
563 .p_arglen = SM_mon_sz,
564 .p_replen = SM_monres_sz,
565 .p_statidx = NSMPROC_MON,
569 .p_proc = NSMPROC_UNMON,
570 .p_encode = (kxdrproc_t)xdr_enc_unmon,
571 .p_decode = (kxdrproc_t)xdr_dec_stat,
572 .p_arglen = SM_mon_id_sz,
573 .p_replen = SM_unmonres_sz,
574 .p_statidx = NSMPROC_UNMON,
575 .p_name = "UNMONITOR",
579 static struct rpc_version nsm_version1 = {
581 .nrprocs = ARRAY_SIZE(nsm_procedures),
582 .procs = nsm_procedures
585 static struct rpc_version * nsm_version[] = {
589 static struct rpc_stat nsm_stats;
591 static struct rpc_program nsm_program = {
593 .number = NSM_PROGRAM,
594 .nrvers = ARRAY_SIZE(nsm_version),
595 .version = nsm_version,