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/svc.h>
17 #include <linux/lockd/lockd.h>
18 #include <linux/mutex.h>
22 #define NLMDBG_FACILITY NLMDBG_HOSTCACHE
23 #define NLM_HOST_NRHASH 32
24 #define NLM_HOST_REBIND (60 * HZ)
25 #define NLM_HOST_EXPIRE (300 * HZ)
26 #define NLM_HOST_COLLECT (120 * HZ)
28 static struct hlist_head nlm_server_hosts
[NLM_HOST_NRHASH
];
29 static struct hlist_head nlm_client_hosts
[NLM_HOST_NRHASH
];
31 #define for_each_host(host, pos, chain, table) \
32 for ((chain) = (table); \
33 (chain) < (table) + NLM_HOST_NRHASH; ++(chain)) \
34 hlist_for_each_entry((host), (pos), (chain), h_hash)
36 #define for_each_host_safe(host, pos, next, chain, table) \
37 for ((chain) = (table); \
38 (chain) < (table) + NLM_HOST_NRHASH; ++(chain)) \
39 hlist_for_each_entry_safe((host), (pos), (next), \
42 static unsigned long next_gc
;
43 static unsigned long nrhosts
;
44 static DEFINE_MUTEX(nlm_host_mutex
);
46 static void nlm_gc_hosts(void);
48 struct nlm_lookup_host_info
{
49 const int server
; /* search for server|client */
50 const struct sockaddr
*sap
; /* address to search for */
51 const size_t salen
; /* it's length */
52 const unsigned short protocol
; /* transport to search for*/
53 const u32 version
; /* NLM version to search for */
54 const char *hostname
; /* remote's hostname */
55 const size_t hostname_len
; /* it's length */
56 const int noresvport
; /* use non-priv port */
60 * Hash function must work well on big- and little-endian platforms
62 static unsigned int __nlm_hash32(const __be32 n
)
64 unsigned int hash
= (__force u32
)n
^ ((__force u32
)n
>> 16);
65 return hash
^ (hash
>> 8);
68 static unsigned int __nlm_hash_addr4(const struct sockaddr
*sap
)
70 const struct sockaddr_in
*sin
= (struct sockaddr_in
*)sap
;
71 return __nlm_hash32(sin
->sin_addr
.s_addr
);
74 static unsigned int __nlm_hash_addr6(const struct sockaddr
*sap
)
76 const struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)sap
;
77 const struct in6_addr addr
= sin6
->sin6_addr
;
78 return __nlm_hash32(addr
.s6_addr32
[0]) ^
79 __nlm_hash32(addr
.s6_addr32
[1]) ^
80 __nlm_hash32(addr
.s6_addr32
[2]) ^
81 __nlm_hash32(addr
.s6_addr32
[3]);
84 static unsigned int nlm_hash_address(const struct sockaddr
*sap
)
88 switch (sap
->sa_family
) {
90 hash
= __nlm_hash_addr4(sap
);
93 hash
= __nlm_hash_addr6(sap
);
98 return hash
& (NLM_HOST_NRHASH
- 1);
102 * Allocate and initialize an nlm_host. Common to both client and server.
104 static struct nlm_host
*nlm_alloc_host(struct nlm_lookup_host_info
*ni
,
105 struct nsm_handle
*nsm
)
107 struct nlm_host
*host
= NULL
;
108 unsigned long now
= jiffies
;
111 atomic_inc(&nsm
->sm_count
);
114 nsm
= nsm_get_handle(ni
->sap
, ni
->salen
,
115 ni
->hostname
, ni
->hostname_len
);
116 if (unlikely(nsm
== NULL
)) {
117 dprintk("lockd: %s failed; no nsm handle\n",
123 host
= kmalloc(sizeof(*host
), GFP_KERNEL
);
124 if (unlikely(host
== NULL
)) {
125 dprintk("lockd: %s failed; no memory\n", __func__
);
130 memcpy(nlm_addr(host
), ni
->sap
, ni
->salen
);
131 host
->h_addrlen
= ni
->salen
;
132 rpc_set_port(nlm_addr(host
), 0);
133 host
->h_srcaddrlen
= 0;
135 host
->h_rpcclnt
= NULL
;
136 host
->h_name
= nsm
->sm_name
;
137 host
->h_version
= ni
->version
;
138 host
->h_proto
= ni
->protocol
;
139 host
->h_reclaiming
= 0;
140 host
->h_server
= ni
->server
;
141 host
->h_noresvport
= ni
->noresvport
;
143 init_waitqueue_head(&host
->h_gracewait
);
144 init_rwsem(&host
->h_rwsem
);
146 host
->h_nsmstate
= 0;
147 host
->h_pidcount
= 0;
148 atomic_set(&host
->h_count
, 1);
149 mutex_init(&host
->h_mutex
);
150 host
->h_nextrebind
= now
+ NLM_HOST_REBIND
;
151 host
->h_expires
= now
+ NLM_HOST_EXPIRE
;
152 INIT_LIST_HEAD(&host
->h_lockowners
);
153 spin_lock_init(&host
->h_lock
);
154 INIT_LIST_HEAD(&host
->h_granted
);
155 INIT_LIST_HEAD(&host
->h_reclaim
);
156 host
->h_nsmhandle
= nsm
;
157 host
->h_addrbuf
= nsm
->sm_addrbuf
;
164 * Destroy an nlm_host and free associated resources
166 * Caller must hold nlm_host_mutex.
168 static void nlm_destroy_host_locked(struct nlm_host
*host
)
170 struct rpc_clnt
*clnt
;
172 dprintk("lockd: destroy host %s\n", host
->h_name
);
174 BUG_ON(!list_empty(&host
->h_lockowners
));
175 BUG_ON(atomic_read(&host
->h_count
));
177 hlist_del_init(&host
->h_hash
);
180 nsm_release(host
->h_nsmhandle
);
182 clnt
= host
->h_rpcclnt
;
184 rpc_shutdown_client(clnt
);
191 * nlmclnt_lookup_host - Find an NLM host handle matching a remote server
192 * @sap: network address of server
193 * @salen: length of server address
194 * @protocol: transport protocol to use
195 * @version: NLM protocol version
196 * @hostname: '\0'-terminated hostname of server
197 * @noresvport: 1 if non-privileged port should be used
199 * Returns an nlm_host structure that matches the passed-in
200 * [server address, transport protocol, NLM version, server hostname].
201 * If one doesn't already exist in the host cache, a new handle is
202 * created and returned.
204 struct nlm_host
*nlmclnt_lookup_host(const struct sockaddr
*sap
,
206 const unsigned short protocol
,
208 const char *hostname
,
211 struct nlm_lookup_host_info ni
= {
215 .protocol
= protocol
,
217 .hostname
= hostname
,
218 .hostname_len
= strlen(hostname
),
219 .noresvport
= noresvport
,
221 struct hlist_head
*chain
;
222 struct hlist_node
*pos
;
223 struct nlm_host
*host
;
224 struct nsm_handle
*nsm
= NULL
;
226 dprintk("lockd: %s(host='%s', vers=%u, proto=%s)\n", __func__
,
227 (hostname
? hostname
: "<none>"), version
,
228 (protocol
== IPPROTO_UDP
? "udp" : "tcp"));
230 mutex_lock(&nlm_host_mutex
);
232 chain
= &nlm_client_hosts
[nlm_hash_address(sap
)];
233 hlist_for_each_entry(host
, pos
, chain
, h_hash
) {
234 if (!rpc_cmp_addr(nlm_addr(host
), sap
))
237 /* Same address. Share an NSM handle if we already have one */
239 nsm
= host
->h_nsmhandle
;
241 if (host
->h_proto
!= protocol
)
243 if (host
->h_version
!= version
)
247 dprintk("lockd: %s found host %s (%s)\n", __func__
,
248 host
->h_name
, host
->h_addrbuf
);
252 host
= nlm_alloc_host(&ni
, nsm
);
253 if (unlikely(host
== NULL
))
256 hlist_add_head(&host
->h_hash
, chain
);
259 dprintk("lockd: %s created host %s (%s)\n", __func__
,
260 host
->h_name
, host
->h_addrbuf
);
263 mutex_unlock(&nlm_host_mutex
);
268 * nlmclnt_release_host - release client nlm_host
269 * @host: nlm_host to release
272 void nlmclnt_release_host(struct nlm_host
*host
)
277 dprintk("lockd: release client host %s\n", host
->h_name
);
279 BUG_ON(atomic_read(&host
->h_count
) < 0);
280 BUG_ON(host
->h_server
);
282 if (atomic_dec_and_test(&host
->h_count
)) {
283 BUG_ON(!list_empty(&host
->h_lockowners
));
284 BUG_ON(!list_empty(&host
->h_granted
));
285 BUG_ON(!list_empty(&host
->h_reclaim
));
287 mutex_lock(&nlm_host_mutex
);
288 nlm_destroy_host_locked(host
);
289 mutex_unlock(&nlm_host_mutex
);
294 * nlmsvc_lookup_host - Find an NLM host handle matching a remote client
295 * @rqstp: incoming NLM request
296 * @hostname: name of client host
297 * @hostname_len: length of client hostname
299 * Returns an nlm_host structure that matches the [client address,
300 * transport protocol, NLM version, client hostname] of the passed-in
301 * NLM request. If one doesn't already exist in the host cache, a
302 * new handle is created and returned.
304 * Before possibly creating a new nlm_host, construct a sockaddr
305 * for a specific source address in case the local system has
306 * multiple network addresses. The family of the address in
307 * rq_daddr is guaranteed to be the same as the family of the
308 * address in rq_addr, so it's safe to use the same family for
309 * the source address.
311 struct nlm_host
*nlmsvc_lookup_host(const struct svc_rqst
*rqstp
,
312 const char *hostname
,
313 const size_t hostname_len
)
315 struct hlist_head
*chain
;
316 struct hlist_node
*pos
;
317 struct nlm_host
*host
= NULL
;
318 struct nsm_handle
*nsm
= NULL
;
319 struct sockaddr_in sin
= {
320 .sin_family
= AF_INET
,
322 struct sockaddr_in6 sin6
= {
323 .sin6_family
= AF_INET6
,
325 struct sockaddr
*src_sap
;
326 size_t src_len
= rqstp
->rq_addrlen
;
327 struct nlm_lookup_host_info ni
= {
329 .sap
= svc_addr(rqstp
),
330 .salen
= rqstp
->rq_addrlen
,
331 .protocol
= rqstp
->rq_prot
,
332 .version
= rqstp
->rq_vers
,
333 .hostname
= hostname
,
334 .hostname_len
= hostname_len
,
337 dprintk("lockd: %s(host='%*s', vers=%u, proto=%s)\n", __func__
,
338 (int)hostname_len
, hostname
, rqstp
->rq_vers
,
339 (rqstp
->rq_prot
== IPPROTO_UDP
? "udp" : "tcp"));
341 mutex_lock(&nlm_host_mutex
);
343 switch (ni
.sap
->sa_family
) {
345 sin
.sin_addr
.s_addr
= rqstp
->rq_daddr
.addr
.s_addr
;
346 src_sap
= (struct sockaddr
*)&sin
;
349 ipv6_addr_copy(&sin6
.sin6_addr
, &rqstp
->rq_daddr
.addr6
);
350 src_sap
= (struct sockaddr
*)&sin6
;
353 dprintk("lockd: %s failed; unrecognized address family\n",
358 if (time_after_eq(jiffies
, next_gc
))
361 chain
= &nlm_server_hosts
[nlm_hash_address(ni
.sap
)];
362 hlist_for_each_entry(host
, pos
, chain
, h_hash
) {
363 if (!rpc_cmp_addr(nlm_addr(host
), ni
.sap
))
366 /* Same address. Share an NSM handle if we already have one */
368 nsm
= host
->h_nsmhandle
;
370 if (host
->h_proto
!= ni
.protocol
)
372 if (host
->h_version
!= ni
.version
)
374 if (!rpc_cmp_addr(nlm_srcaddr(host
), src_sap
))
377 /* Move to head of hash chain. */
378 hlist_del(&host
->h_hash
);
379 hlist_add_head(&host
->h_hash
, chain
);
382 dprintk("lockd: %s found host %s (%s)\n",
383 __func__
, host
->h_name
, host
->h_addrbuf
);
387 host
= nlm_alloc_host(&ni
, nsm
);
388 if (unlikely(host
== NULL
))
391 memcpy(nlm_srcaddr(host
), src_sap
, src_len
);
392 host
->h_srcaddrlen
= src_len
;
393 hlist_add_head(&host
->h_hash
, chain
);
396 dprintk("lockd: %s created host %s (%s)\n",
397 __func__
, host
->h_name
, host
->h_addrbuf
);
400 mutex_unlock(&nlm_host_mutex
);
405 * nlmsvc_release_host - release server nlm_host
406 * @host: nlm_host to release
408 * Host is destroyed later in nlm_gc_host().
410 void nlmsvc_release_host(struct nlm_host
*host
)
415 dprintk("lockd: release server host %s\n", host
->h_name
);
417 BUG_ON(atomic_read(&host
->h_count
) < 0);
418 BUG_ON(!host
->h_server
);
419 atomic_dec(&host
->h_count
);
423 * Create the NLM RPC client for an NLM peer
426 nlm_bind_host(struct nlm_host
*host
)
428 struct rpc_clnt
*clnt
;
430 dprintk("lockd: nlm_bind_host %s (%s)\n",
431 host
->h_name
, host
->h_addrbuf
);
433 /* Lock host handle */
434 mutex_lock(&host
->h_mutex
);
436 /* If we've already created an RPC client, check whether
437 * RPC rebind is required
439 if ((clnt
= host
->h_rpcclnt
) != NULL
) {
440 if (time_after_eq(jiffies
, host
->h_nextrebind
)) {
441 rpc_force_rebind(clnt
);
442 host
->h_nextrebind
= jiffies
+ NLM_HOST_REBIND
;
443 dprintk("lockd: next rebind in %lu jiffies\n",
444 host
->h_nextrebind
- jiffies
);
447 unsigned long increment
= nlmsvc_timeout
;
448 struct rpc_timeout timeparms
= {
449 .to_initval
= increment
,
450 .to_increment
= increment
,
451 .to_maxval
= increment
* 6UL,
454 struct rpc_create_args args
= {
456 .protocol
= host
->h_proto
,
457 .address
= nlm_addr(host
),
458 .addrsize
= host
->h_addrlen
,
459 .timeout
= &timeparms
,
460 .servername
= host
->h_name
,
461 .program
= &nlm_program
,
462 .version
= host
->h_version
,
463 .authflavor
= RPC_AUTH_UNIX
,
464 .flags
= (RPC_CLNT_CREATE_NOPING
|
465 RPC_CLNT_CREATE_AUTOBIND
),
469 * lockd retries server side blocks automatically so we want
470 * those to be soft RPC calls. Client side calls need to be
474 args
.flags
|= RPC_CLNT_CREATE_HARDRTRY
;
475 if (host
->h_noresvport
)
476 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
477 if (host
->h_srcaddrlen
)
478 args
.saddress
= nlm_srcaddr(host
);
480 clnt
= rpc_create(&args
);
482 host
->h_rpcclnt
= clnt
;
484 printk("lockd: couldn't create RPC handle for %s\n", host
->h_name
);
489 mutex_unlock(&host
->h_mutex
);
494 * Force a portmap lookup of the remote lockd port
497 nlm_rebind_host(struct nlm_host
*host
)
499 dprintk("lockd: rebind host %s\n", host
->h_name
);
500 if (host
->h_rpcclnt
&& time_after_eq(jiffies
, host
->h_nextrebind
)) {
501 rpc_force_rebind(host
->h_rpcclnt
);
502 host
->h_nextrebind
= jiffies
+ NLM_HOST_REBIND
;
507 * Increment NLM host count
509 struct nlm_host
* nlm_get_host(struct nlm_host
*host
)
512 dprintk("lockd: get host %s\n", host
->h_name
);
513 atomic_inc(&host
->h_count
);
514 host
->h_expires
= jiffies
+ NLM_HOST_EXPIRE
;
519 static struct nlm_host
*next_host_state(struct hlist_head
*cache
,
520 struct nsm_handle
*nsm
,
521 const struct nlm_reboot
*info
)
523 struct nlm_host
*host
;
524 struct hlist_head
*chain
;
525 struct hlist_node
*pos
;
527 mutex_lock(&nlm_host_mutex
);
528 for_each_host(host
, pos
, chain
, cache
) {
529 if (host
->h_nsmhandle
== nsm
530 && host
->h_nsmstate
!= info
->state
) {
531 host
->h_nsmstate
= info
->state
;
535 mutex_unlock(&nlm_host_mutex
);
540 mutex_unlock(&nlm_host_mutex
);
545 * nlm_host_rebooted - Release all resources held by rebooted host
546 * @info: pointer to decoded results of NLM_SM_NOTIFY call
548 * We were notified that the specified host has rebooted. Release
549 * all resources held by that peer.
551 void nlm_host_rebooted(const struct nlm_reboot
*info
)
553 struct nsm_handle
*nsm
;
554 struct nlm_host
*host
;
556 nsm
= nsm_reboot_lookup(info
);
557 if (unlikely(nsm
== NULL
))
560 /* Mark all hosts tied to this NSM state as having rebooted.
561 * We run the loop repeatedly, because we drop the host table
563 * To avoid processing a host several times, we match the nsmstate.
565 while ((host
= next_host_state(nlm_server_hosts
, nsm
, info
)) != NULL
) {
566 nlmsvc_free_host_resources(host
);
567 nlmsvc_release_host(host
);
569 while ((host
= next_host_state(nlm_client_hosts
, nsm
, info
)) != NULL
) {
570 nlmclnt_recovery(host
);
571 nlmclnt_release_host(host
);
578 * Shut down the hosts module.
579 * Note that this routine is called only at server shutdown time.
582 nlm_shutdown_hosts(void)
584 struct hlist_head
*chain
;
585 struct hlist_node
*pos
;
586 struct nlm_host
*host
;
588 dprintk("lockd: shutting down host module\n");
589 mutex_lock(&nlm_host_mutex
);
591 /* First, make all hosts eligible for gc */
592 dprintk("lockd: nuking all hosts...\n");
593 for_each_host(host
, pos
, chain
, nlm_server_hosts
) {
594 host
->h_expires
= jiffies
- 1;
595 if (host
->h_rpcclnt
) {
596 rpc_shutdown_client(host
->h_rpcclnt
);
597 host
->h_rpcclnt
= NULL
;
601 /* Then, perform a garbage collection pass */
603 mutex_unlock(&nlm_host_mutex
);
605 /* complain if any hosts are left */
607 printk(KERN_WARNING
"lockd: couldn't shutdown host module!\n");
608 dprintk("lockd: %lu hosts left:\n", nrhosts
);
609 for_each_host(host
, pos
, chain
, nlm_server_hosts
) {
610 dprintk(" %s (cnt %d use %d exp %ld)\n",
611 host
->h_name
, atomic_read(&host
->h_count
),
612 host
->h_inuse
, host
->h_expires
);
618 * Garbage collect any unused NLM hosts.
619 * This GC combines reference counting for async operations with
620 * mark & sweep for resources held by remote clients.
625 struct hlist_head
*chain
;
626 struct hlist_node
*pos
, *next
;
627 struct nlm_host
*host
;
629 dprintk("lockd: host garbage collection\n");
630 for_each_host(host
, pos
, chain
, nlm_server_hosts
)
633 /* Mark all hosts that hold locks, blocks or shares */
634 nlmsvc_mark_resources();
636 for_each_host_safe(host
, pos
, next
, chain
, nlm_server_hosts
) {
637 if (atomic_read(&host
->h_count
) || host
->h_inuse
638 || time_before(jiffies
, host
->h_expires
)) {
639 dprintk("nlm_gc_hosts skipping %s "
640 "(cnt %d use %d exp %ld)\n",
641 host
->h_name
, atomic_read(&host
->h_count
),
642 host
->h_inuse
, host
->h_expires
);
645 nlm_destroy_host_locked(host
);
648 next_gc
= jiffies
+ NLM_HOST_COLLECT
;