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
);
162 if (status
== -ECONNREFUSED
) {
163 dprintk("lockd: NSM upcall RPC failed, status=%d, forcing rebind\n",
165 rpc_force_rebind(clnt
);
166 status
= rpc_call_sync(clnt
, &msg
, RPC_TASK_SOFTCONN
);
169 dprintk("lockd: NSM upcall RPC failed, status=%d\n",
177 * nsm_monitor - Notify a peer in case we reboot
178 * @host: pointer to nlm_host of peer to notify
180 * If this peer is not already monitored, this function sends an
181 * upcall to the local rpc.statd to record the name/address of
182 * the peer to notify in case we reboot.
184 * Returns zero if the peer is monitored by the local rpc.statd;
185 * otherwise a negative errno value is returned.
187 int nsm_monitor(const struct nlm_host
*host
)
189 struct nsm_handle
*nsm
= host
->h_nsmhandle
;
192 struct rpc_clnt
*clnt
;
194 dprintk("lockd: nsm_monitor(%s)\n", nsm
->sm_name
);
196 if (nsm
->sm_monitored
)
200 * Choose whether to record the caller_name or IP address of
201 * this peer in the local rpc.statd's database.
203 nsm
->sm_mon_name
= nsm_use_hostnames
? nsm
->sm_name
: nsm
->sm_addrbuf
;
205 clnt
= nsm_client_get(host
->net
);
207 status
= PTR_ERR(clnt
);
208 dprintk("lockd: failed to create NSM upcall transport, "
209 "status=%d, net=%p\n", status
, host
->net
);
213 status
= nsm_mon_unmon(nsm
, NSMPROC_MON
, &res
, clnt
);
214 if (unlikely(res
.status
!= 0))
216 if (unlikely(status
< 0)) {
217 pr_notice_ratelimited("lockd: cannot monitor %s\n", nsm
->sm_name
);
221 nsm
->sm_monitored
= 1;
222 if (unlikely(nsm_local_state
!= res
.state
)) {
223 nsm_local_state
= res
.state
;
224 dprintk("lockd: NSM state changed to %d\n", nsm_local_state
);
230 * nsm_unmonitor - Unregister peer notification
231 * @host: pointer to nlm_host of peer to stop monitoring
233 * If this peer is monitored, this function sends an upcall to
234 * tell the local rpc.statd not to send this peer a notification
237 void nsm_unmonitor(const struct nlm_host
*host
)
239 struct nsm_handle
*nsm
= host
->h_nsmhandle
;
243 if (atomic_read(&nsm
->sm_count
) == 1
244 && nsm
->sm_monitored
&& !nsm
->sm_sticky
) {
245 struct lockd_net
*ln
= net_generic(host
->net
, lockd_net_id
);
247 dprintk("lockd: nsm_unmonitor(%s)\n", nsm
->sm_name
);
249 status
= nsm_mon_unmon(nsm
, NSMPROC_UNMON
, &res
, ln
->nsm_clnt
);
253 printk(KERN_NOTICE
"lockd: cannot unmonitor %s\n",
256 nsm
->sm_monitored
= 0;
258 nsm_client_put(host
->net
);
262 static struct nsm_handle
*nsm_lookup_hostname(const char *hostname
,
265 struct nsm_handle
*nsm
;
267 list_for_each_entry(nsm
, &nsm_handles
, sm_link
)
268 if (strlen(nsm
->sm_name
) == len
&&
269 memcmp(nsm
->sm_name
, hostname
, len
) == 0)
274 static struct nsm_handle
*nsm_lookup_addr(const struct sockaddr
*sap
)
276 struct nsm_handle
*nsm
;
278 list_for_each_entry(nsm
, &nsm_handles
, sm_link
)
279 if (rpc_cmp_addr(nsm_addr(nsm
), sap
))
284 static struct nsm_handle
*nsm_lookup_priv(const struct nsm_private
*priv
)
286 struct nsm_handle
*nsm
;
288 list_for_each_entry(nsm
, &nsm_handles
, sm_link
)
289 if (memcmp(nsm
->sm_priv
.data
, priv
->data
,
290 sizeof(priv
->data
)) == 0)
296 * Construct a unique cookie to match this nsm_handle to this monitored
297 * host. It is passed to the local rpc.statd via NSMPROC_MON, and
298 * returned via NLMPROC_SM_NOTIFY, in the "priv" field of these
301 * The NSM protocol requires that these cookies be unique while the
302 * system is running. We prefer a stronger requirement of making them
303 * unique across reboots. If user space bugs cause a stale cookie to
304 * be sent to the kernel, it could cause the wrong host to lose its
305 * lock state if cookies were not unique across reboots.
307 * The cookies are exposed only to local user space via loopback. They
308 * do not appear on the physical network. If we want greater security
309 * for some reason, nsm_init_private() could perform a one-way hash to
310 * obscure the contents of the cookie.
312 static void nsm_init_private(struct nsm_handle
*nsm
)
314 u64
*p
= (u64
*)&nsm
->sm_priv
.data
;
318 put_unaligned(ns
, p
);
319 put_unaligned((unsigned long)nsm
, p
+ 1);
322 static struct nsm_handle
*nsm_create_handle(const struct sockaddr
*sap
,
324 const char *hostname
,
325 const size_t hostname_len
)
327 struct nsm_handle
*new;
329 new = kzalloc(sizeof(*new) + hostname_len
+ 1, GFP_KERNEL
);
330 if (unlikely(new == NULL
))
333 atomic_set(&new->sm_count
, 1);
334 new->sm_name
= (char *)(new + 1);
335 memcpy(nsm_addr(new), sap
, salen
);
336 new->sm_addrlen
= salen
;
337 nsm_init_private(new);
339 if (rpc_ntop(nsm_addr(new), new->sm_addrbuf
,
340 sizeof(new->sm_addrbuf
)) == 0)
341 (void)snprintf(new->sm_addrbuf
, sizeof(new->sm_addrbuf
),
342 "unsupported address family");
343 memcpy(new->sm_name
, hostname
, hostname_len
);
344 new->sm_name
[hostname_len
] = '\0';
350 * nsm_get_handle - Find or create a cached nsm_handle
351 * @sap: pointer to socket address of handle to find
352 * @salen: length of socket address
353 * @hostname: pointer to C string containing hostname to find
354 * @hostname_len: length of C string
356 * Behavior is modulated by the global nsm_use_hostnames variable.
358 * Returns a cached nsm_handle after bumping its ref count, or
359 * returns a fresh nsm_handle if a handle that matches @sap and/or
360 * @hostname cannot be found in the handle cache. Returns NULL if
363 struct nsm_handle
*nsm_get_handle(const struct sockaddr
*sap
,
364 const size_t salen
, const char *hostname
,
365 const size_t hostname_len
)
367 struct nsm_handle
*cached
, *new = NULL
;
369 if (hostname
&& memchr(hostname
, '/', hostname_len
) != NULL
) {
370 if (printk_ratelimit()) {
371 printk(KERN_WARNING
"Invalid hostname \"%.*s\" "
372 "in NFS lock request\n",
373 (int)hostname_len
, hostname
);
379 spin_lock(&nsm_lock
);
381 if (nsm_use_hostnames
&& hostname
!= NULL
)
382 cached
= nsm_lookup_hostname(hostname
, hostname_len
);
384 cached
= nsm_lookup_addr(sap
);
386 if (cached
!= NULL
) {
387 atomic_inc(&cached
->sm_count
);
388 spin_unlock(&nsm_lock
);
390 dprintk("lockd: found nsm_handle for %s (%s), "
391 "cnt %d\n", cached
->sm_name
,
393 atomic_read(&cached
->sm_count
));
398 list_add(&new->sm_link
, &nsm_handles
);
399 spin_unlock(&nsm_lock
);
400 dprintk("lockd: created nsm_handle for %s (%s)\n",
401 new->sm_name
, new->sm_addrbuf
);
405 spin_unlock(&nsm_lock
);
407 new = nsm_create_handle(sap
, salen
, hostname
, hostname_len
);
408 if (unlikely(new == NULL
))
414 * nsm_reboot_lookup - match NLMPROC_SM_NOTIFY arguments to an nsm_handle
415 * @info: pointer to NLMPROC_SM_NOTIFY arguments
417 * Returns a matching nsm_handle if found in the nsm cache. The returned
418 * nsm_handle's reference count is bumped. Otherwise returns NULL if some
421 struct nsm_handle
*nsm_reboot_lookup(const struct nlm_reboot
*info
)
423 struct nsm_handle
*cached
;
425 spin_lock(&nsm_lock
);
427 cached
= nsm_lookup_priv(&info
->priv
);
428 if (unlikely(cached
== NULL
)) {
429 spin_unlock(&nsm_lock
);
430 dprintk("lockd: never saw rebooted peer '%.*s' before\n",
431 info
->len
, info
->mon
);
435 atomic_inc(&cached
->sm_count
);
436 spin_unlock(&nsm_lock
);
438 dprintk("lockd: host %s (%s) rebooted, cnt %d\n",
439 cached
->sm_name
, cached
->sm_addrbuf
,
440 atomic_read(&cached
->sm_count
));
445 * nsm_release - Release an NSM handle
446 * @nsm: pointer to handle to be released
449 void nsm_release(struct nsm_handle
*nsm
)
451 if (atomic_dec_and_lock(&nsm
->sm_count
, &nsm_lock
)) {
452 list_del(&nsm
->sm_link
);
453 spin_unlock(&nsm_lock
);
454 dprintk("lockd: destroyed nsm_handle for %s (%s)\n",
455 nsm
->sm_name
, nsm
->sm_addrbuf
);
461 * XDR functions for NSM.
463 * See http://www.opengroup.org/ for details on the Network
464 * Status Monitor wire protocol.
467 static void encode_nsm_string(struct xdr_stream
*xdr
, const char *string
)
469 const u32 len
= strlen(string
);
472 p
= xdr_reserve_space(xdr
, 4 + len
);
473 xdr_encode_opaque(p
, string
, len
);
477 * "mon_name" specifies the host to be monitored.
479 static void encode_mon_name(struct xdr_stream
*xdr
, const struct nsm_args
*argp
)
481 encode_nsm_string(xdr
, argp
->mon_name
);
485 * The "my_id" argument specifies the hostname and RPC procedure
486 * to be called when the status manager receives notification
487 * (via the NLMPROC_SM_NOTIFY call) that the state of host "mon_name"
490 static void encode_my_id(struct xdr_stream
*xdr
, const struct nsm_args
*argp
)
494 encode_nsm_string(xdr
, argp
->nodename
);
495 p
= xdr_reserve_space(xdr
, 4 + 4 + 4);
496 *p
++ = cpu_to_be32(argp
->prog
);
497 *p
++ = cpu_to_be32(argp
->vers
);
498 *p
= cpu_to_be32(argp
->proc
);
502 * The "mon_id" argument specifies the non-private arguments
503 * of an NSMPROC_MON or NSMPROC_UNMON call.
505 static void encode_mon_id(struct xdr_stream
*xdr
, const struct nsm_args
*argp
)
507 encode_mon_name(xdr
, argp
);
508 encode_my_id(xdr
, argp
);
512 * The "priv" argument may contain private information required
513 * by the NSMPROC_MON call. This information will be supplied in the
514 * NLMPROC_SM_NOTIFY call.
516 static void encode_priv(struct xdr_stream
*xdr
, const struct nsm_args
*argp
)
520 p
= xdr_reserve_space(xdr
, SM_PRIV_SIZE
);
521 xdr_encode_opaque_fixed(p
, argp
->priv
->data
, SM_PRIV_SIZE
);
524 static void nsm_xdr_enc_mon(struct rpc_rqst
*req
, struct xdr_stream
*xdr
,
525 const struct nsm_args
*argp
)
527 encode_mon_id(xdr
, argp
);
528 encode_priv(xdr
, argp
);
531 static void nsm_xdr_enc_unmon(struct rpc_rqst
*req
, struct xdr_stream
*xdr
,
532 const struct nsm_args
*argp
)
534 encode_mon_id(xdr
, argp
);
537 static int nsm_xdr_dec_stat_res(struct rpc_rqst
*rqstp
,
538 struct xdr_stream
*xdr
,
539 struct nsm_res
*resp
)
543 p
= xdr_inline_decode(xdr
, 4 + 4);
544 if (unlikely(p
== NULL
))
546 resp
->status
= be32_to_cpup(p
++);
547 resp
->state
= be32_to_cpup(p
);
549 dprintk("lockd: %s status %d state %d\n",
550 __func__
, resp
->status
, resp
->state
);
554 static int nsm_xdr_dec_stat(struct rpc_rqst
*rqstp
,
555 struct xdr_stream
*xdr
,
556 struct nsm_res
*resp
)
560 p
= xdr_inline_decode(xdr
, 4);
561 if (unlikely(p
== NULL
))
563 resp
->state
= be32_to_cpup(p
);
565 dprintk("lockd: %s state %d\n", __func__
, resp
->state
);
569 #define SM_my_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
570 #define SM_my_id_sz (SM_my_name_sz+3)
571 #define SM_mon_name_sz (1+XDR_QUADLEN(SM_MAXSTRLEN))
572 #define SM_mon_id_sz (SM_mon_name_sz+SM_my_id_sz)
573 #define SM_priv_sz (XDR_QUADLEN(SM_PRIV_SIZE))
574 #define SM_mon_sz (SM_mon_id_sz+SM_priv_sz)
575 #define SM_monres_sz 2
576 #define SM_unmonres_sz 1
578 static struct rpc_procinfo nsm_procedures
[] = {
580 .p_proc
= NSMPROC_MON
,
581 .p_encode
= (kxdreproc_t
)nsm_xdr_enc_mon
,
582 .p_decode
= (kxdrdproc_t
)nsm_xdr_dec_stat_res
,
583 .p_arglen
= SM_mon_sz
,
584 .p_replen
= SM_monres_sz
,
585 .p_statidx
= NSMPROC_MON
,
589 .p_proc
= NSMPROC_UNMON
,
590 .p_encode
= (kxdreproc_t
)nsm_xdr_enc_unmon
,
591 .p_decode
= (kxdrdproc_t
)nsm_xdr_dec_stat
,
592 .p_arglen
= SM_mon_id_sz
,
593 .p_replen
= SM_unmonres_sz
,
594 .p_statidx
= NSMPROC_UNMON
,
595 .p_name
= "UNMONITOR",
599 static const struct rpc_version nsm_version1
= {
601 .nrprocs
= ARRAY_SIZE(nsm_procedures
),
602 .procs
= nsm_procedures
605 static const struct rpc_version
*nsm_version
[] = {
609 static struct rpc_stat nsm_stats
;
611 static const struct rpc_program nsm_program
= {
613 .number
= NSM_PROGRAM
,
614 .nrvers
= ARRAY_SIZE(nsm_version
),
615 .version
= nsm_version
,