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;
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
210 * Linux provides the raw IP address of the monitored host,
211 * left in network byte order.
213 static void nsm_init_private(struct nsm_handle *nsm)
215 __be32 *p = (__be32 *)&nsm->sm_priv.data;
216 *p = nsm_addr_in(nsm)->sin_addr.s_addr;
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
227 * Behavior is modulated by the global nsm_use_hostnames variable
228 * and by the @create argument.
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.
235 struct nsm_handle *nsm_find(const struct sockaddr *sap, const size_t salen,
236 const char *hostname, const size_t hostname_len,
239 struct nsm_handle *nsm = NULL;
240 struct nsm_handle *pos;
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);
252 spin_lock(&nsm_lock);
253 list_for_each_entry(pos, &nsm_handles, sm_link) {
255 if (hostname && nsm_use_hostnames) {
256 if (strlen(pos->sm_name) != hostname_len
257 || memcmp(pos->sm_name, hostname, hostname_len))
259 } else if (!nlm_cmp_addr(nsm_addr(pos), sap))
261 atomic_inc(&pos->sm_count);
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));
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);
275 spin_unlock(&nsm_lock);
280 nsm = kzalloc(sizeof(*nsm) + hostname_len + 1, GFP_KERNEL);
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);
296 spin_unlock(&nsm_lock);
301 * nsm_release - Release an NSM handle
302 * @nsm: pointer to handle to be released
305 void nsm_release(struct nsm_handle *nsm)
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);
317 * Create NSM client for the local host
319 static struct rpc_clnt *
322 struct sockaddr_in sin = {
323 .sin_family = AF_INET,
324 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
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,
337 return rpc_create(&args);
341 * XDR functions for NSM.
343 * See http://www.opengroup.org/ for details on the Network
344 * Status Monitor wire protocol.
347 static int encode_nsm_string(struct xdr_stream *xdr, const char *string)
349 const u32 len = strlen(string);
352 if (unlikely(len > SM_MAXSTRLEN))
354 p = xdr_reserve_space(xdr, sizeof(u32) + len);
355 if (unlikely(p == NULL))
357 xdr_encode_opaque(p, string, len);
362 * "mon_name" specifies the host to be monitored.
364 static int encode_mon_name(struct xdr_stream *xdr, const struct nsm_args *argp)
366 return encode_nsm_string(xdr, argp->mon_name);
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"
375 static int encode_my_id(struct xdr_stream *xdr, const struct nsm_args *argp)
380 status = encode_nsm_string(xdr, utsname()->nodename);
381 if (unlikely(status != 0))
383 p = xdr_reserve_space(xdr, 3 * sizeof(u32));
384 if (unlikely(p == NULL))
386 *p++ = htonl(argp->prog);
387 *p++ = htonl(argp->vers);
388 *p++ = htonl(argp->proc);
393 * The "mon_id" argument specifies the non-private arguments
394 * of an NSMPROC_MON or NSMPROC_UNMON call.
396 static int encode_mon_id(struct xdr_stream *xdr, const struct nsm_args *argp)
400 status = encode_mon_name(xdr, argp);
401 if (unlikely(status != 0))
403 return encode_my_id(xdr, argp);
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.
411 static int encode_priv(struct xdr_stream *xdr, const struct nsm_args *argp)
415 p = xdr_reserve_space(xdr, SM_PRIV_SIZE);
416 if (unlikely(p == NULL))
418 xdr_encode_opaque_fixed(p, argp->priv->data, SM_PRIV_SIZE);
422 static int xdr_enc_mon(struct rpc_rqst *req, __be32 *p,
423 const struct nsm_args *argp)
425 struct xdr_stream xdr;
428 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
429 status = encode_mon_id(&xdr, argp);
430 if (unlikely(status))
432 return encode_priv(&xdr, argp);
435 static int xdr_enc_unmon(struct rpc_rqst *req, __be32 *p,
436 const struct nsm_args *argp)
438 struct xdr_stream xdr;
440 xdr_init_encode(&xdr, &req->rq_snd_buf, p);
441 return encode_mon_id(&xdr, argp);
444 static int xdr_dec_stat_res(struct rpc_rqst *rqstp, __be32 *p,
445 struct nsm_res *resp)
447 struct xdr_stream xdr;
449 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
450 p = xdr_inline_decode(&xdr, 2 * sizeof(u32));
451 if (unlikely(p == NULL))
453 resp->status = ntohl(*p++);
454 resp->state = ntohl(*p);
456 dprintk("lockd: xdr_dec_stat_res status %d state %d\n",
457 resp->status, resp->state);
461 static int xdr_dec_stat(struct rpc_rqst *rqstp, __be32 *p,
462 struct nsm_res *resp)
464 struct xdr_stream xdr;
466 xdr_init_decode(&xdr, &rqstp->rq_rcv_buf, p);
467 p = xdr_inline_decode(&xdr, sizeof(u32));
468 if (unlikely(p == NULL))
470 resp->state = ntohl(*p);
472 dprintk("lockd: xdr_dec_stat state %d\n", resp->state);
476 #define SM_my_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
477 #define SM_my_id_sz (SM_my_name_sz+3)
478 #define SM_mon_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
479 #define SM_mon_id_sz (SM_mon_name_sz+SM_my_id_sz)
480 #define SM_priv_sz (XDR_QUADLEN(SM_PRIV_SIZE))
481 #define SM_mon_sz (SM_mon_id_sz+SM_priv_sz)
482 #define SM_monres_sz 2
483 #define SM_unmonres_sz 1
485 static struct rpc_procinfo nsm_procedures[] = {
487 .p_proc = NSMPROC_MON,
488 .p_encode = (kxdrproc_t)xdr_enc_mon,
489 .p_decode = (kxdrproc_t)xdr_dec_stat_res,
490 .p_arglen = SM_mon_sz,
491 .p_replen = SM_monres_sz,
492 .p_statidx = NSMPROC_MON,
496 .p_proc = NSMPROC_UNMON,
497 .p_encode = (kxdrproc_t)xdr_enc_unmon,
498 .p_decode = (kxdrproc_t)xdr_dec_stat,
499 .p_arglen = SM_mon_id_sz,
500 .p_replen = SM_unmonres_sz,
501 .p_statidx = NSMPROC_UNMON,
502 .p_name = "UNMONITOR",
506 static struct rpc_version nsm_version1 = {
508 .nrprocs = ARRAY_SIZE(nsm_procedures),
509 .procs = nsm_procedures
512 static struct rpc_version * nsm_version[] = {
516 static struct rpc_stat nsm_stats;
518 static struct rpc_program nsm_program = {
520 .number = NSM_PROGRAM,
521 .nrvers = ARRAY_SIZE(nsm_version),
522 .version = nsm_version,