2 * linux/fs/lockd/host.c
4 * Management for NLM peer hosts. The nlm_host struct is shared
5 * between client and server implementation. The only reason to
6 * do so is to reduce code bloat.
8 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
11 #include <linux/types.h>
12 #include <linux/slab.h>
14 #include <linux/in6.h>
15 #include <linux/sunrpc/clnt.h>
16 #include <linux/sunrpc/addr.h>
17 #include <linux/sunrpc/svc.h>
18 #include <linux/lockd/lockd.h>
19 #include <linux/mutex.h>
21 #include <linux/sunrpc/svc_xprt.h>
27 #define NLMDBG_FACILITY NLMDBG_HOSTCACHE
28 #define NLM_HOST_NRHASH 32
29 #define NLM_HOST_REBIND (60 * HZ)
30 #define NLM_HOST_EXPIRE (300 * HZ)
31 #define NLM_HOST_COLLECT (120 * HZ)
33 static struct hlist_head nlm_server_hosts
[NLM_HOST_NRHASH
];
34 static struct hlist_head nlm_client_hosts
[NLM_HOST_NRHASH
];
36 #define for_each_host(host, chain, table) \
37 for ((chain) = (table); \
38 (chain) < (table) + NLM_HOST_NRHASH; ++(chain)) \
39 hlist_for_each_entry((host), (chain), h_hash)
41 #define for_each_host_safe(host, next, chain, table) \
42 for ((chain) = (table); \
43 (chain) < (table) + NLM_HOST_NRHASH; ++(chain)) \
44 hlist_for_each_entry_safe((host), (next), \
47 static unsigned long nrhosts
;
48 static DEFINE_MUTEX(nlm_host_mutex
);
50 static void nlm_gc_hosts(struct net
*net
);
52 struct nlm_lookup_host_info
{
53 const int server
; /* search for server|client */
54 const struct sockaddr
*sap
; /* address to search for */
55 const size_t salen
; /* it's length */
56 const unsigned short protocol
; /* transport to search for*/
57 const u32 version
; /* NLM version to search for */
58 const char *hostname
; /* remote's hostname */
59 const size_t hostname_len
; /* it's length */
60 const int noresvport
; /* use non-priv port */
61 struct net
*net
; /* network namespace to bind */
65 * Hash function must work well on big- and little-endian platforms
67 static unsigned int __nlm_hash32(const __be32 n
)
69 unsigned int hash
= (__force u32
)n
^ ((__force u32
)n
>> 16);
70 return hash
^ (hash
>> 8);
73 static unsigned int __nlm_hash_addr4(const struct sockaddr
*sap
)
75 const struct sockaddr_in
*sin
= (struct sockaddr_in
*)sap
;
76 return __nlm_hash32(sin
->sin_addr
.s_addr
);
79 static unsigned int __nlm_hash_addr6(const struct sockaddr
*sap
)
81 const struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)sap
;
82 const struct in6_addr addr
= sin6
->sin6_addr
;
83 return __nlm_hash32(addr
.s6_addr32
[0]) ^
84 __nlm_hash32(addr
.s6_addr32
[1]) ^
85 __nlm_hash32(addr
.s6_addr32
[2]) ^
86 __nlm_hash32(addr
.s6_addr32
[3]);
89 static unsigned int nlm_hash_address(const struct sockaddr
*sap
)
93 switch (sap
->sa_family
) {
95 hash
= __nlm_hash_addr4(sap
);
98 hash
= __nlm_hash_addr6(sap
);
103 return hash
& (NLM_HOST_NRHASH
- 1);
107 * Allocate and initialize an nlm_host. Common to both client and server.
109 static struct nlm_host
*nlm_alloc_host(struct nlm_lookup_host_info
*ni
,
110 struct nsm_handle
*nsm
)
112 struct nlm_host
*host
= NULL
;
113 unsigned long now
= jiffies
;
116 atomic_inc(&nsm
->sm_count
);
119 nsm
= nsm_get_handle(ni
->net
, ni
->sap
, ni
->salen
,
120 ni
->hostname
, ni
->hostname_len
);
121 if (unlikely(nsm
== NULL
)) {
122 dprintk("lockd: %s failed; no nsm handle\n",
128 host
= kmalloc(sizeof(*host
), GFP_KERNEL
);
129 if (unlikely(host
== NULL
)) {
130 dprintk("lockd: %s failed; no memory\n", __func__
);
135 memcpy(nlm_addr(host
), ni
->sap
, ni
->salen
);
136 host
->h_addrlen
= ni
->salen
;
137 rpc_set_port(nlm_addr(host
), 0);
138 host
->h_srcaddrlen
= 0;
140 host
->h_rpcclnt
= NULL
;
141 host
->h_name
= nsm
->sm_name
;
142 host
->h_version
= ni
->version
;
143 host
->h_proto
= ni
->protocol
;
144 host
->h_reclaiming
= 0;
145 host
->h_server
= ni
->server
;
146 host
->h_noresvport
= ni
->noresvport
;
148 init_waitqueue_head(&host
->h_gracewait
);
149 init_rwsem(&host
->h_rwsem
);
151 host
->h_nsmstate
= 0;
152 host
->h_pidcount
= 0;
153 atomic_set(&host
->h_count
, 1);
154 mutex_init(&host
->h_mutex
);
155 host
->h_nextrebind
= now
+ NLM_HOST_REBIND
;
156 host
->h_expires
= now
+ NLM_HOST_EXPIRE
;
157 INIT_LIST_HEAD(&host
->h_lockowners
);
158 spin_lock_init(&host
->h_lock
);
159 INIT_LIST_HEAD(&host
->h_granted
);
160 INIT_LIST_HEAD(&host
->h_reclaim
);
161 host
->h_nsmhandle
= nsm
;
162 host
->h_addrbuf
= nsm
->sm_addrbuf
;
164 strlcpy(host
->nodename
, utsname()->nodename
, sizeof(host
->nodename
));
171 * Destroy an nlm_host and free associated resources
173 * Caller must hold nlm_host_mutex.
175 static void nlm_destroy_host_locked(struct nlm_host
*host
)
177 struct rpc_clnt
*clnt
;
178 struct lockd_net
*ln
= net_generic(host
->net
, lockd_net_id
);
180 dprintk("lockd: destroy host %s\n", host
->h_name
);
182 hlist_del_init(&host
->h_hash
);
185 nsm_release(host
->h_nsmhandle
);
187 clnt
= host
->h_rpcclnt
;
189 rpc_shutdown_client(clnt
);
197 * nlmclnt_lookup_host - Find an NLM host handle matching a remote server
198 * @sap: network address of server
199 * @salen: length of server address
200 * @protocol: transport protocol to use
201 * @version: NLM protocol version
202 * @hostname: '\0'-terminated hostname of server
203 * @noresvport: 1 if non-privileged port should be used
205 * Returns an nlm_host structure that matches the passed-in
206 * [server address, transport protocol, NLM version, server hostname].
207 * If one doesn't already exist in the host cache, a new handle is
208 * created and returned.
210 struct nlm_host
*nlmclnt_lookup_host(const struct sockaddr
*sap
,
212 const unsigned short protocol
,
214 const char *hostname
,
218 struct nlm_lookup_host_info ni
= {
222 .protocol
= protocol
,
224 .hostname
= hostname
,
225 .hostname_len
= strlen(hostname
),
226 .noresvport
= noresvport
,
229 struct hlist_head
*chain
;
230 struct nlm_host
*host
;
231 struct nsm_handle
*nsm
= NULL
;
232 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
234 dprintk("lockd: %s(host='%s', vers=%u, proto=%s)\n", __func__
,
235 (hostname
? hostname
: "<none>"), version
,
236 (protocol
== IPPROTO_UDP
? "udp" : "tcp"));
238 mutex_lock(&nlm_host_mutex
);
240 chain
= &nlm_client_hosts
[nlm_hash_address(sap
)];
241 hlist_for_each_entry(host
, chain
, h_hash
) {
242 if (host
->net
!= net
)
244 if (!rpc_cmp_addr(nlm_addr(host
), sap
))
247 /* Same address. Share an NSM handle if we already have one */
249 nsm
= host
->h_nsmhandle
;
251 if (host
->h_proto
!= protocol
)
253 if (host
->h_version
!= version
)
257 dprintk("lockd: %s found host %s (%s)\n", __func__
,
258 host
->h_name
, host
->h_addrbuf
);
262 host
= nlm_alloc_host(&ni
, nsm
);
263 if (unlikely(host
== NULL
))
266 hlist_add_head(&host
->h_hash
, chain
);
270 dprintk("lockd: %s created host %s (%s)\n", __func__
,
271 host
->h_name
, host
->h_addrbuf
);
274 mutex_unlock(&nlm_host_mutex
);
279 * nlmclnt_release_host - release client nlm_host
280 * @host: nlm_host to release
283 void nlmclnt_release_host(struct nlm_host
*host
)
288 dprintk("lockd: release client host %s\n", host
->h_name
);
290 WARN_ON_ONCE(host
->h_server
);
292 if (atomic_dec_and_test(&host
->h_count
)) {
293 WARN_ON_ONCE(!list_empty(&host
->h_lockowners
));
294 WARN_ON_ONCE(!list_empty(&host
->h_granted
));
295 WARN_ON_ONCE(!list_empty(&host
->h_reclaim
));
297 mutex_lock(&nlm_host_mutex
);
298 nlm_destroy_host_locked(host
);
299 mutex_unlock(&nlm_host_mutex
);
304 * nlmsvc_lookup_host - Find an NLM host handle matching a remote client
305 * @rqstp: incoming NLM request
306 * @hostname: name of client host
307 * @hostname_len: length of client hostname
309 * Returns an nlm_host structure that matches the [client address,
310 * transport protocol, NLM version, client hostname] of the passed-in
311 * NLM request. If one doesn't already exist in the host cache, a
312 * new handle is created and returned.
314 * Before possibly creating a new nlm_host, construct a sockaddr
315 * for a specific source address in case the local system has
316 * multiple network addresses. The family of the address in
317 * rq_daddr is guaranteed to be the same as the family of the
318 * address in rq_addr, so it's safe to use the same family for
319 * the source address.
321 struct nlm_host
*nlmsvc_lookup_host(const struct svc_rqst
*rqstp
,
322 const char *hostname
,
323 const size_t hostname_len
)
325 struct hlist_head
*chain
;
326 struct nlm_host
*host
= NULL
;
327 struct nsm_handle
*nsm
= NULL
;
328 struct sockaddr
*src_sap
= svc_daddr(rqstp
);
329 size_t src_len
= rqstp
->rq_daddrlen
;
330 struct net
*net
= SVC_NET(rqstp
);
331 struct nlm_lookup_host_info ni
= {
333 .sap
= svc_addr(rqstp
),
334 .salen
= rqstp
->rq_addrlen
,
335 .protocol
= rqstp
->rq_prot
,
336 .version
= rqstp
->rq_vers
,
337 .hostname
= hostname
,
338 .hostname_len
= hostname_len
,
341 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
343 dprintk("lockd: %s(host='%.*s', vers=%u, proto=%s)\n", __func__
,
344 (int)hostname_len
, hostname
, rqstp
->rq_vers
,
345 (rqstp
->rq_prot
== IPPROTO_UDP
? "udp" : "tcp"));
347 mutex_lock(&nlm_host_mutex
);
349 if (time_after_eq(jiffies
, ln
->next_gc
))
352 chain
= &nlm_server_hosts
[nlm_hash_address(ni
.sap
)];
353 hlist_for_each_entry(host
, chain
, h_hash
) {
354 if (host
->net
!= net
)
356 if (!rpc_cmp_addr(nlm_addr(host
), ni
.sap
))
359 /* Same address. Share an NSM handle if we already have one */
361 nsm
= host
->h_nsmhandle
;
363 if (host
->h_proto
!= ni
.protocol
)
365 if (host
->h_version
!= ni
.version
)
367 if (!rpc_cmp_addr(nlm_srcaddr(host
), src_sap
))
370 /* Move to head of hash chain. */
371 hlist_del(&host
->h_hash
);
372 hlist_add_head(&host
->h_hash
, chain
);
375 dprintk("lockd: %s found host %s (%s)\n",
376 __func__
, host
->h_name
, host
->h_addrbuf
);
380 host
= nlm_alloc_host(&ni
, nsm
);
381 if (unlikely(host
== NULL
))
384 memcpy(nlm_srcaddr(host
), src_sap
, src_len
);
385 host
->h_srcaddrlen
= src_len
;
386 hlist_add_head(&host
->h_hash
, chain
);
390 dprintk("lockd: %s created host %s (%s)\n",
391 __func__
, host
->h_name
, host
->h_addrbuf
);
394 mutex_unlock(&nlm_host_mutex
);
399 * nlmsvc_release_host - release server nlm_host
400 * @host: nlm_host to release
402 * Host is destroyed later in nlm_gc_host().
404 void nlmsvc_release_host(struct nlm_host
*host
)
409 dprintk("lockd: release server host %s\n", host
->h_name
);
411 WARN_ON_ONCE(!host
->h_server
);
412 atomic_dec(&host
->h_count
);
416 * Create the NLM RPC client for an NLM peer
419 nlm_bind_host(struct nlm_host
*host
)
421 struct rpc_clnt
*clnt
;
423 dprintk("lockd: nlm_bind_host %s (%s)\n",
424 host
->h_name
, host
->h_addrbuf
);
426 /* Lock host handle */
427 mutex_lock(&host
->h_mutex
);
429 /* If we've already created an RPC client, check whether
430 * RPC rebind is required
432 if ((clnt
= host
->h_rpcclnt
) != NULL
) {
433 nlm_rebind_host(host
);
435 unsigned long increment
= nlmsvc_timeout
;
436 struct rpc_timeout timeparms
= {
437 .to_initval
= increment
,
438 .to_increment
= increment
,
439 .to_maxval
= increment
* 6UL,
442 struct rpc_create_args args
= {
444 .protocol
= host
->h_proto
,
445 .address
= nlm_addr(host
),
446 .addrsize
= host
->h_addrlen
,
447 .timeout
= &timeparms
,
448 .servername
= host
->h_name
,
449 .program
= &nlm_program
,
450 .version
= host
->h_version
,
451 .authflavor
= RPC_AUTH_UNIX
,
452 .flags
= (RPC_CLNT_CREATE_NOPING
|
453 RPC_CLNT_CREATE_AUTOBIND
),
457 * lockd retries server side blocks automatically so we want
458 * those to be soft RPC calls. Client side calls need to be
462 args
.flags
|= RPC_CLNT_CREATE_HARDRTRY
;
463 if (host
->h_noresvport
)
464 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
465 if (host
->h_srcaddrlen
)
466 args
.saddress
= nlm_srcaddr(host
);
468 clnt
= rpc_create(&args
);
470 host
->h_rpcclnt
= clnt
;
472 printk("lockd: couldn't create RPC handle for %s\n", host
->h_name
);
477 mutex_unlock(&host
->h_mutex
);
482 * nlm_rebind_host - If needed, force a portmap lookup of the peer's lockd port
483 * @host: NLM host handle for peer
485 * This is not needed when using a connection-oriented protocol, such as TCP.
486 * The existing autobind mechanism is sufficient to force a rebind when
487 * required, e.g. on connection state transitions.
490 nlm_rebind_host(struct nlm_host
*host
)
492 if (host
->h_proto
!= IPPROTO_UDP
)
495 if (host
->h_rpcclnt
&& time_after_eq(jiffies
, host
->h_nextrebind
)) {
496 rpc_force_rebind(host
->h_rpcclnt
);
497 host
->h_nextrebind
= jiffies
+ NLM_HOST_REBIND
;
502 * Increment NLM host count
504 struct nlm_host
* nlm_get_host(struct nlm_host
*host
)
507 dprintk("lockd: get host %s\n", host
->h_name
);
508 atomic_inc(&host
->h_count
);
509 host
->h_expires
= jiffies
+ NLM_HOST_EXPIRE
;
514 static struct nlm_host
*next_host_state(struct hlist_head
*cache
,
515 struct nsm_handle
*nsm
,
516 const struct nlm_reboot
*info
)
518 struct nlm_host
*host
;
519 struct hlist_head
*chain
;
521 mutex_lock(&nlm_host_mutex
);
522 for_each_host(host
, chain
, cache
) {
523 if (host
->h_nsmhandle
== nsm
524 && host
->h_nsmstate
!= info
->state
) {
525 host
->h_nsmstate
= info
->state
;
529 mutex_unlock(&nlm_host_mutex
);
534 mutex_unlock(&nlm_host_mutex
);
539 * nlm_host_rebooted - Release all resources held by rebooted host
540 * @net: network namespace
541 * @info: pointer to decoded results of NLM_SM_NOTIFY call
543 * We were notified that the specified host has rebooted. Release
544 * all resources held by that peer.
546 void nlm_host_rebooted(const struct net
*net
, const struct nlm_reboot
*info
)
548 struct nsm_handle
*nsm
;
549 struct nlm_host
*host
;
551 nsm
= nsm_reboot_lookup(net
, info
);
552 if (unlikely(nsm
== NULL
))
555 /* Mark all hosts tied to this NSM state as having rebooted.
556 * We run the loop repeatedly, because we drop the host table
558 * To avoid processing a host several times, we match the nsmstate.
560 while ((host
= next_host_state(nlm_server_hosts
, nsm
, info
)) != NULL
) {
561 nlmsvc_free_host_resources(host
);
562 nlmsvc_release_host(host
);
564 while ((host
= next_host_state(nlm_client_hosts
, nsm
, info
)) != NULL
) {
565 nlmclnt_recovery(host
);
566 nlmclnt_release_host(host
);
572 static void nlm_complain_hosts(struct net
*net
)
574 struct hlist_head
*chain
;
575 struct nlm_host
*host
;
578 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
580 if (ln
->nrhosts
== 0)
582 printk(KERN_WARNING
"lockd: couldn't shutdown host module for net %p!\n", net
);
583 dprintk("lockd: %lu hosts left in net %p:\n", ln
->nrhosts
, net
);
587 printk(KERN_WARNING
"lockd: couldn't shutdown host module!\n");
588 dprintk("lockd: %lu hosts left:\n", nrhosts
);
591 for_each_host(host
, chain
, nlm_server_hosts
) {
592 if (net
&& host
->net
!= net
)
594 dprintk(" %s (cnt %d use %d exp %ld net %p)\n",
595 host
->h_name
, atomic_read(&host
->h_count
),
596 host
->h_inuse
, host
->h_expires
, host
->net
);
601 nlm_shutdown_hosts_net(struct net
*net
)
603 struct hlist_head
*chain
;
604 struct nlm_host
*host
;
606 mutex_lock(&nlm_host_mutex
);
608 /* First, make all hosts eligible for gc */
609 dprintk("lockd: nuking all hosts in net %p...\n", net
);
610 for_each_host(host
, chain
, nlm_server_hosts
) {
611 if (net
&& host
->net
!= net
)
613 host
->h_expires
= jiffies
- 1;
614 if (host
->h_rpcclnt
) {
615 rpc_shutdown_client(host
->h_rpcclnt
);
616 host
->h_rpcclnt
= NULL
;
620 /* Then, perform a garbage collection pass */
622 mutex_unlock(&nlm_host_mutex
);
624 nlm_complain_hosts(net
);
628 * Shut down the hosts module.
629 * Note that this routine is called only at server shutdown time.
632 nlm_shutdown_hosts(void)
634 dprintk("lockd: shutting down host module\n");
635 nlm_shutdown_hosts_net(NULL
);
639 * Garbage collect any unused NLM hosts.
640 * This GC combines reference counting for async operations with
641 * mark & sweep for resources held by remote clients.
644 nlm_gc_hosts(struct net
*net
)
646 struct hlist_head
*chain
;
647 struct hlist_node
*next
;
648 struct nlm_host
*host
;
650 dprintk("lockd: host garbage collection for net %p\n", net
);
651 for_each_host(host
, chain
, nlm_server_hosts
) {
652 if (net
&& host
->net
!= net
)
657 /* Mark all hosts that hold locks, blocks or shares */
658 nlmsvc_mark_resources(net
);
660 for_each_host_safe(host
, next
, chain
, nlm_server_hosts
) {
661 if (net
&& host
->net
!= net
)
663 if (atomic_read(&host
->h_count
) || host
->h_inuse
664 || time_before(jiffies
, host
->h_expires
)) {
665 dprintk("nlm_gc_hosts skipping %s "
666 "(cnt %d use %d exp %ld net %p)\n",
667 host
->h_name
, atomic_read(&host
->h_count
),
668 host
->h_inuse
, host
->h_expires
, host
->net
);
671 nlm_destroy_host_locked(host
);
675 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
677 ln
->next_gc
= jiffies
+ NLM_HOST_COLLECT
;