4 * The kernel statd client.
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
9 #include <linux/types.h>
10 #include <linux/kernel.h>
11 #include <linux/ktime.h>
12 #include <linux/slab.h>
14 #include <linux/sunrpc/clnt.h>
15 #include <linux/sunrpc/addr.h>
16 #include <linux/sunrpc/xprtsock.h>
17 #include <linux/sunrpc/svc.h>
18 #include <linux/lockd/lockd.h>
20 #include <asm/unaligned.h>
24 #define NLMDBG_FACILITY NLMDBG_MONITOR
25 #define NSM_PROGRAM 100024
39 struct nsm_private
*priv
;
40 u32 prog
; /* RPC callback info */
53 static const struct rpc_program nsm_program
;
54 static LIST_HEAD(nsm_handles
);
55 static DEFINE_SPINLOCK(nsm_lock
);
60 u32 __read_mostly nsm_local_state
;
61 bool __read_mostly nsm_use_hostnames
;
63 static inline struct sockaddr
*nsm_addr(const struct nsm_handle
*nsm
)
65 return (struct sockaddr
*)&nsm
->sm_addr
;
68 static struct rpc_clnt
*nsm_create(struct net
*net
)
70 struct sockaddr_in sin
= {
71 .sin_family
= AF_INET
,
72 .sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
),
74 struct rpc_create_args args
= {
76 .protocol
= XPRT_TRANSPORT_TCP
,
77 .address
= (struct sockaddr
*)&sin
,
78 .addrsize
= sizeof(sin
),
79 .servername
= "rpc.statd",
80 .program
= &nsm_program
,
81 .version
= NSM_VERSION
,
82 .authflavor
= RPC_AUTH_NULL
,
83 .flags
= RPC_CLNT_CREATE_NOPING
,
86 return rpc_create(&args
);
89 static struct rpc_clnt
*nsm_client_set(struct lockd_net
*ln
,
90 struct rpc_clnt
*clnt
)
92 spin_lock(&ln
->nsm_clnt_lock
);
93 if (ln
->nsm_users
== 0) {
101 spin_unlock(&ln
->nsm_clnt_lock
);
105 static struct rpc_clnt
*nsm_client_get(struct net
*net
)
107 struct rpc_clnt
*clnt
, *new;
108 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
110 clnt
= nsm_client_set(ln
, NULL
);
114 clnt
= new = nsm_create(net
);
118 clnt
= nsm_client_set(ln
, new);
120 rpc_shutdown_client(new);
125 static void nsm_client_put(struct net
*net
)
127 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
128 struct rpc_clnt
*clnt
= NULL
;
130 spin_lock(&ln
->nsm_clnt_lock
);
132 if (ln
->nsm_users
== 0) {
136 spin_unlock(&ln
->nsm_clnt_lock
);
138 rpc_shutdown_client(clnt
);
141 static int nsm_mon_unmon(struct nsm_handle
*nsm
, u32 proc
, struct nsm_res
*res
,
142 struct rpc_clnt
*clnt
)
145 struct nsm_args args
= {
146 .priv
= &nsm
->sm_priv
,
149 .proc
= NLMPROC_NSM_NOTIFY
,
150 .mon_name
= nsm
->sm_mon_name
,
151 .nodename
= clnt
->cl_nodename
,
153 struct rpc_message msg
= {
158 memset(res
, 0, sizeof(*res
));
160 msg
.rpc_proc
= &clnt
->cl_procinfo
[proc
];
161 status
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFTCONN
);
163 dprintk("lockd: NSM upcall RPC failed, status=%d\n",
171 * nsm_monitor - Notify a peer in case we reboot
172 * @host: pointer to nlm_host of peer to notify
174 * If this peer is not already monitored, this function sends an
175 * upcall to the local rpc.statd to record the name/address of
176 * the peer to notify in case we reboot.
178 * Returns zero if the peer is monitored by the local rpc.statd;
179 * otherwise a negative errno value is returned.
181 int nsm_monitor(const struct nlm_host
*host
)
183 struct nsm_handle
*nsm
= host
->h_nsmhandle
;
186 struct rpc_clnt
*clnt
;
188 dprintk("lockd: nsm_monitor(%s)\n", nsm
->sm_name
);
190 if (nsm
->sm_monitored
)
194 * Choose whether to record the caller_name or IP address of
195 * this peer in the local rpc.statd's database.
197 nsm
->sm_mon_name
= nsm_use_hostnames
? nsm
->sm_name
: nsm
->sm_addrbuf
;
199 clnt
= nsm_client_get(host
->net
);
201 status
= PTR_ERR(clnt
);
202 dprintk("lockd: failed to create NSM upcall transport, "
203 "status=%d, net=%p\n", status
, host
->net
);
207 status
= nsm_mon_unmon(nsm
, NSMPROC_MON
, &res
, clnt
);
208 if (unlikely(res
.status
!= 0))
210 if (unlikely(status
< 0)) {
211 printk(KERN_NOTICE
"lockd: cannot monitor %s\n", nsm
->sm_name
);
215 nsm
->sm_monitored
= 1;
216 if (unlikely(nsm_local_state
!= res
.state
)) {
217 nsm_local_state
= res
.state
;
218 dprintk("lockd: NSM state changed to %d\n", nsm_local_state
);
224 * nsm_unmonitor - Unregister peer notification
225 * @host: pointer to nlm_host of peer to stop monitoring
227 * If this peer is monitored, this function sends an upcall to
228 * tell the local rpc.statd not to send this peer a notification
231 void nsm_unmonitor(const struct nlm_host
*host
)
233 struct nsm_handle
*nsm
= host
->h_nsmhandle
;
237 if (atomic_read(&nsm
->sm_count
) == 1
238 && nsm
->sm_monitored
&& !nsm
->sm_sticky
) {
239 struct lockd_net
*ln
= net_generic(host
->net
, lockd_net_id
);
241 dprintk("lockd: nsm_unmonitor(%s)\n", nsm
->sm_name
);
243 status
= nsm_mon_unmon(nsm
, NSMPROC_UNMON
, &res
, ln
->nsm_clnt
);
247 printk(KERN_NOTICE
"lockd: cannot unmonitor %s\n",
250 nsm
->sm_monitored
= 0;
252 nsm_client_put(host
->net
);
256 static struct nsm_handle
*nsm_lookup_hostname(const char *hostname
,
259 struct nsm_handle
*nsm
;
261 list_for_each_entry(nsm
, &nsm_handles
, sm_link
)
262 if (strlen(nsm
->sm_name
) == len
&&
263 memcmp(nsm
->sm_name
, hostname
, len
) == 0)
268 static struct nsm_handle
*nsm_lookup_addr(const struct sockaddr
*sap
)
270 struct nsm_handle
*nsm
;
272 list_for_each_entry(nsm
, &nsm_handles
, sm_link
)
273 if (rpc_cmp_addr(nsm_addr(nsm
), sap
))
278 static struct nsm_handle
*nsm_lookup_priv(const struct nsm_private
*priv
)
280 struct nsm_handle
*nsm
;
282 list_for_each_entry(nsm
, &nsm_handles
, sm_link
)
283 if (memcmp(nsm
->sm_priv
.data
, priv
->data
,
284 sizeof(priv
->data
)) == 0)
290 * Construct a unique cookie to match this nsm_handle to this monitored
291 * host. It is passed to the local rpc.statd via NSMPROC_MON, and
292 * returned via NLMPROC_SM_NOTIFY, in the "priv" field of these
295 * The NSM protocol requires that these cookies be unique while the
296 * system is running. We prefer a stronger requirement of making them
297 * unique across reboots. If user space bugs cause a stale cookie to
298 * be sent to the kernel, it could cause the wrong host to lose its
299 * lock state if cookies were not unique across reboots.
301 * The cookies are exposed only to local user space via loopback. They
302 * do not appear on the physical network. If we want greater security
303 * for some reason, nsm_init_private() could perform a one-way hash to
304 * obscure the contents of the cookie.
306 static void nsm_init_private(struct nsm_handle
*nsm
)
308 u64
*p
= (u64
*)&nsm
->sm_priv
.data
;
313 ns
= timespec_to_ns(&ts
);
314 put_unaligned(ns
, p
);
315 put_unaligned((unsigned long)nsm
, p
+ 1);
318 static struct nsm_handle
*nsm_create_handle(const struct sockaddr
*sap
,
320 const char *hostname
,
321 const size_t hostname_len
)
323 struct nsm_handle
*new;
325 new = kzalloc(sizeof(*new) + hostname_len
+ 1, GFP_KERNEL
);
326 if (unlikely(new == NULL
))
329 atomic_set(&new->sm_count
, 1);
330 new->sm_name
= (char *)(new + 1);
331 memcpy(nsm_addr(new), sap
, salen
);
332 new->sm_addrlen
= salen
;
333 nsm_init_private(new);
335 if (rpc_ntop(nsm_addr(new), new->sm_addrbuf
,
336 sizeof(new->sm_addrbuf
)) == 0)
337 (void)snprintf(new->sm_addrbuf
, sizeof(new->sm_addrbuf
),
338 "unsupported address family");
339 memcpy(new->sm_name
, hostname
, hostname_len
);
340 new->sm_name
[hostname_len
] = '\0';
346 * nsm_get_handle - Find or create a cached nsm_handle
347 * @sap: pointer to socket address of handle to find
348 * @salen: length of socket address
349 * @hostname: pointer to C string containing hostname to find
350 * @hostname_len: length of C string
352 * Behavior is modulated by the global nsm_use_hostnames variable.
354 * Returns a cached nsm_handle after bumping its ref count, or
355 * returns a fresh nsm_handle if a handle that matches @sap and/or
356 * @hostname cannot be found in the handle cache. Returns NULL if
359 struct nsm_handle
*nsm_get_handle(const struct sockaddr
*sap
,
360 const size_t salen
, const char *hostname
,
361 const size_t hostname_len
)
363 struct nsm_handle
*cached
, *new = NULL
;
365 if (hostname
&& memchr(hostname
, '/', hostname_len
) != NULL
) {
366 if (printk_ratelimit()) {
367 printk(KERN_WARNING
"Invalid hostname \"%.*s\" "
368 "in NFS lock request\n",
369 (int)hostname_len
, hostname
);
375 spin_lock(&nsm_lock
);
377 if (nsm_use_hostnames
&& hostname
!= NULL
)
378 cached
= nsm_lookup_hostname(hostname
, hostname_len
);
380 cached
= nsm_lookup_addr(sap
);
382 if (cached
!= NULL
) {
383 atomic_inc(&cached
->sm_count
);
384 spin_unlock(&nsm_lock
);
386 dprintk("lockd: found nsm_handle for %s (%s), "
387 "cnt %d\n", cached
->sm_name
,
389 atomic_read(&cached
->sm_count
));
394 list_add(&new->sm_link
, &nsm_handles
);
395 spin_unlock(&nsm_lock
);
396 dprintk("lockd: created nsm_handle for %s (%s)\n",
397 new->sm_name
, new->sm_addrbuf
);
401 spin_unlock(&nsm_lock
);
403 new = nsm_create_handle(sap
, salen
, hostname
, hostname_len
);
404 if (unlikely(new == NULL
))
410 * nsm_reboot_lookup - match NLMPROC_SM_NOTIFY arguments to an nsm_handle
411 * @info: pointer to NLMPROC_SM_NOTIFY arguments
413 * Returns a matching nsm_handle if found in the nsm cache. The returned
414 * nsm_handle's reference count is bumped. Otherwise returns NULL if some
417 struct nsm_handle
*nsm_reboot_lookup(const struct nlm_reboot
*info
)
419 struct nsm_handle
*cached
;
421 spin_lock(&nsm_lock
);
423 cached
= nsm_lookup_priv(&info
->priv
);
424 if (unlikely(cached
== NULL
)) {
425 spin_unlock(&nsm_lock
);
426 dprintk("lockd: never saw rebooted peer '%.*s' before\n",
427 info
->len
, info
->mon
);
431 atomic_inc(&cached
->sm_count
);
432 spin_unlock(&nsm_lock
);
434 dprintk("lockd: host %s (%s) rebooted, cnt %d\n",
435 cached
->sm_name
, cached
->sm_addrbuf
,
436 atomic_read(&cached
->sm_count
));
441 * nsm_release - Release an NSM handle
442 * @nsm: pointer to handle to be released
445 void nsm_release(struct nsm_handle
*nsm
)
447 if (atomic_dec_and_lock(&nsm
->sm_count
, &nsm_lock
)) {
448 list_del(&nsm
->sm_link
);
449 spin_unlock(&nsm_lock
);
450 dprintk("lockd: destroyed nsm_handle for %s (%s)\n",
451 nsm
->sm_name
, nsm
->sm_addrbuf
);
457 * XDR functions for NSM.
459 * See http://www.opengroup.org/ for details on the Network
460 * Status Monitor wire protocol.
463 static void encode_nsm_string(struct xdr_stream
*xdr
, const char *string
)
465 const u32 len
= strlen(string
);
468 p
= xdr_reserve_space(xdr
, 4 + len
);
469 xdr_encode_opaque(p
, string
, len
);
473 * "mon_name" specifies the host to be monitored.
475 static void encode_mon_name(struct xdr_stream
*xdr
, const struct nsm_args
*argp
)
477 encode_nsm_string(xdr
, argp
->mon_name
);
481 * The "my_id" argument specifies the hostname and RPC procedure
482 * to be called when the status manager receives notification
483 * (via the NLMPROC_SM_NOTIFY call) that the state of host "mon_name"
486 static void encode_my_id(struct xdr_stream
*xdr
, const struct nsm_args
*argp
)
490 encode_nsm_string(xdr
, argp
->nodename
);
491 p
= xdr_reserve_space(xdr
, 4 + 4 + 4);
492 *p
++ = cpu_to_be32(argp
->prog
);
493 *p
++ = cpu_to_be32(argp
->vers
);
494 *p
= cpu_to_be32(argp
->proc
);
498 * The "mon_id" argument specifies the non-private arguments
499 * of an NSMPROC_MON or NSMPROC_UNMON call.
501 static void encode_mon_id(struct xdr_stream
*xdr
, const struct nsm_args
*argp
)
503 encode_mon_name(xdr
, argp
);
504 encode_my_id(xdr
, argp
);
508 * The "priv" argument may contain private information required
509 * by the NSMPROC_MON call. This information will be supplied in the
510 * NLMPROC_SM_NOTIFY call.
512 static void encode_priv(struct xdr_stream
*xdr
, const struct nsm_args
*argp
)
516 p
= xdr_reserve_space(xdr
, SM_PRIV_SIZE
);
517 xdr_encode_opaque_fixed(p
, argp
->priv
->data
, SM_PRIV_SIZE
);
520 static void nsm_xdr_enc_mon(struct rpc_rqst
*req
, struct xdr_stream
*xdr
,
521 const struct nsm_args
*argp
)
523 encode_mon_id(xdr
, argp
);
524 encode_priv(xdr
, argp
);
527 static void nsm_xdr_enc_unmon(struct rpc_rqst
*req
, struct xdr_stream
*xdr
,
528 const struct nsm_args
*argp
)
530 encode_mon_id(xdr
, argp
);
533 static int nsm_xdr_dec_stat_res(struct rpc_rqst
*rqstp
,
534 struct xdr_stream
*xdr
,
535 struct nsm_res
*resp
)
539 p
= xdr_inline_decode(xdr
, 4 + 4);
540 if (unlikely(p
== NULL
))
542 resp
->status
= be32_to_cpup(p
++);
543 resp
->state
= be32_to_cpup(p
);
545 dprintk("lockd: %s status %d state %d\n",
546 __func__
, resp
->status
, resp
->state
);
550 static int nsm_xdr_dec_stat(struct rpc_rqst
*rqstp
,
551 struct xdr_stream
*xdr
,
552 struct nsm_res
*resp
)
556 p
= xdr_inline_decode(xdr
, 4);
557 if (unlikely(p
== NULL
))
559 resp
->state
= be32_to_cpup(p
);
561 dprintk("lockd: %s state %d\n", __func__
, resp
->state
);
565 #define SM_my_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
566 #define SM_my_id_sz (SM_my_name_sz+3)
567 #define SM_mon_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
568 #define SM_mon_id_sz (SM_mon_name_sz+SM_my_id_sz)
569 #define SM_priv_sz (XDR_QUADLEN(SM_PRIV_SIZE))
570 #define SM_mon_sz (SM_mon_id_sz+SM_priv_sz)
571 #define SM_monres_sz 2
572 #define SM_unmonres_sz 1
574 static struct rpc_procinfo nsm_procedures
[] = {
576 .p_proc
= NSMPROC_MON
,
577 .p_encode
= (kxdreproc_t
)nsm_xdr_enc_mon
,
578 .p_decode
= (kxdrdproc_t
)nsm_xdr_dec_stat_res
,
579 .p_arglen
= SM_mon_sz
,
580 .p_replen
= SM_monres_sz
,
581 .p_statidx
= NSMPROC_MON
,
585 .p_proc
= NSMPROC_UNMON
,
586 .p_encode
= (kxdreproc_t
)nsm_xdr_enc_unmon
,
587 .p_decode
= (kxdrdproc_t
)nsm_xdr_dec_stat
,
588 .p_arglen
= SM_mon_id_sz
,
589 .p_replen
= SM_unmonres_sz
,
590 .p_statidx
= NSMPROC_UNMON
,
591 .p_name
= "UNMONITOR",
595 static const struct rpc_version nsm_version1
= {
597 .nrprocs
= ARRAY_SIZE(nsm_procedures
),
598 .procs
= nsm_procedures
601 static const struct rpc_version
*nsm_version
[] = {
605 static struct rpc_stat nsm_stats
;
607 static const struct rpc_program nsm_program
= {
609 .number
= NSM_PROGRAM
,
610 .nrvers
= ARRAY_SIZE(nsm_version
),
611 .version
= nsm_version
,