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/lockd/sm_inter.h>
19 #include <linux/mutex.h>
23 #define NLMDBG_FACILITY NLMDBG_HOSTCACHE
24 #define NLM_HOST_NRHASH 32
25 #define NLM_ADDRHASH(addr) (ntohl(addr) & (NLM_HOST_NRHASH-1))
26 #define NLM_HOST_REBIND (60 * HZ)
27 #define NLM_HOST_EXPIRE (300 * HZ)
28 #define NLM_HOST_COLLECT (120 * HZ)
30 static struct hlist_head nlm_hosts[NLM_HOST_NRHASH];
31 static unsigned long next_gc;
33 static DEFINE_MUTEX(nlm_host_mutex);
36 static void nlm_gc_hosts(void);
37 static struct nsm_handle * __nsm_find(const struct sockaddr_in *,
38 const char *, unsigned int, int);
39 static struct nsm_handle * nsm_find(const struct sockaddr_in *sin,
41 unsigned int hostname_len);
43 static void nlm_display_address(const struct sockaddr *sap,
44 char *buf, const size_t len)
46 const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
47 const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
49 switch (sap->sa_family) {
51 snprintf(buf, len, "unspecified");
54 snprintf(buf, len, NIPQUAD_FMT, NIPQUAD(sin->sin_addr.s_addr));
57 if (ipv6_addr_v4mapped(&sin6->sin6_addr))
58 snprintf(buf, len, NIPQUAD_FMT,
59 NIPQUAD(sin6->sin6_addr.s6_addr32[3]));
61 snprintf(buf, len, NIP6_FMT, NIP6(sin6->sin6_addr));
64 snprintf(buf, len, "unsupported address family");
70 * Common host lookup routine for server & client
72 static struct nlm_host *nlm_lookup_host(int server,
73 const struct sockaddr_in *sin,
74 int proto, u32 version,
76 unsigned int hostname_len,
77 const struct sockaddr_in *ssin)
79 struct hlist_head *chain;
80 struct hlist_node *pos;
81 struct nlm_host *host;
82 struct nsm_handle *nsm = NULL;
85 dprintk("lockd: nlm_lookup_host(proto=%d, vers=%u,"
86 " my role is %s, hostname=%.*s)\n",
87 proto, version, server ? "server" : "client",
88 hostname_len, hostname ? hostname : "<none>");
90 hash = NLM_ADDRHASH(sin->sin_addr.s_addr);
93 mutex_lock(&nlm_host_mutex);
95 if (time_after_eq(jiffies, next_gc))
98 /* We may keep several nlm_host objects for a peer, because each
99 * nlm_host is identified by
100 * (address, protocol, version, server/client)
101 * We could probably simplify this a little by putting all those
102 * different NLM rpc_clients into one single nlm_host object.
103 * This would allow us to have one nlm_host per address.
105 chain = &nlm_hosts[hash];
106 hlist_for_each_entry(host, pos, chain, h_hash) {
107 if (!nlm_cmp_addr(&host->h_addr, sin))
110 /* See if we have an NSM handle for this client */
112 nsm = host->h_nsmhandle;
114 if (host->h_proto != proto)
116 if (host->h_version != version)
118 if (host->h_server != server)
120 if (!nlm_cmp_addr(&host->h_saddr, ssin))
123 /* Move to head of hash chain. */
124 hlist_del(&host->h_hash);
125 hlist_add_head(&host->h_hash, chain);
128 dprintk("lockd: nlm_lookup_host found host %s (%s)\n",
129 host->h_name, host->h_addrbuf);
134 * The host wasn't in our hash table. If we don't
135 * have an NSM handle for it yet, create one.
138 atomic_inc(&nsm->sm_count);
141 nsm = nsm_find(sin, hostname, hostname_len);
143 dprintk("lockd: nlm_lookup_host failed; "
149 host = kzalloc(sizeof(*host), GFP_KERNEL);
152 dprintk("lockd: nlm_lookup_host failed; no memory\n");
155 host->h_name = nsm->sm_name;
157 host->h_addr.sin_port = 0; /* ouch! */
158 host->h_saddr = *ssin;
159 host->h_version = version;
160 host->h_proto = proto;
161 host->h_rpcclnt = NULL;
162 mutex_init(&host->h_mutex);
163 host->h_nextrebind = jiffies + NLM_HOST_REBIND;
164 host->h_expires = jiffies + NLM_HOST_EXPIRE;
165 atomic_set(&host->h_count, 1);
166 init_waitqueue_head(&host->h_gracewait);
167 init_rwsem(&host->h_rwsem);
168 host->h_state = 0; /* pseudo NSM state */
169 host->h_nsmstate = 0; /* real NSM state */
170 host->h_nsmhandle = nsm;
171 host->h_server = server;
172 hlist_add_head(&host->h_hash, chain);
173 INIT_LIST_HEAD(&host->h_lockowners);
174 spin_lock_init(&host->h_lock);
175 INIT_LIST_HEAD(&host->h_granted);
176 INIT_LIST_HEAD(&host->h_reclaim);
180 nlm_display_address((struct sockaddr *)&host->h_addr,
181 host->h_addrbuf, sizeof(host->h_addrbuf));
182 nlm_display_address((struct sockaddr *)&host->h_saddr,
183 host->h_saddrbuf, sizeof(host->h_saddrbuf));
185 dprintk("lockd: nlm_lookup_host created host %s\n",
189 mutex_unlock(&nlm_host_mutex);
197 nlm_destroy_host(struct nlm_host *host)
199 struct rpc_clnt *clnt;
201 BUG_ON(!list_empty(&host->h_lockowners));
202 BUG_ON(atomic_read(&host->h_count));
205 * Release NSM handle and unmonitor host.
209 clnt = host->h_rpcclnt;
211 rpc_shutdown_client(clnt);
216 * Find an NLM server handle in the cache. If there is none, create it.
218 struct nlm_host *nlmclnt_lookup_host(const struct sockaddr_in *sin,
219 int proto, u32 version,
220 const char *hostname,
221 unsigned int hostname_len)
223 struct sockaddr_in ssin = {0};
225 return nlm_lookup_host(0, sin, proto, version,
226 hostname, hostname_len, &ssin);
230 * Find an NLM client handle in the cache. If there is none, create it.
233 nlmsvc_lookup_host(struct svc_rqst *rqstp,
234 const char *hostname, unsigned int hostname_len)
236 struct sockaddr_in ssin = {0};
238 ssin.sin_addr = rqstp->rq_daddr.addr;
239 return nlm_lookup_host(1, svc_addr_in(rqstp),
240 rqstp->rq_prot, rqstp->rq_vers,
241 hostname, hostname_len, &ssin);
245 * Create the NLM RPC client for an NLM peer
248 nlm_bind_host(struct nlm_host *host)
250 struct rpc_clnt *clnt;
252 dprintk("lockd: nlm_bind_host %s (%s), my addr=%s\n",
253 host->h_name, host->h_addrbuf, host->h_saddrbuf);
255 /* Lock host handle */
256 mutex_lock(&host->h_mutex);
258 /* If we've already created an RPC client, check whether
259 * RPC rebind is required
261 if ((clnt = host->h_rpcclnt) != NULL) {
262 if (time_after_eq(jiffies, host->h_nextrebind)) {
263 rpc_force_rebind(clnt);
264 host->h_nextrebind = jiffies + NLM_HOST_REBIND;
265 dprintk("lockd: next rebind in %lu jiffies\n",
266 host->h_nextrebind - jiffies);
269 unsigned long increment = nlmsvc_timeout;
270 struct rpc_timeout timeparms = {
271 .to_initval = increment,
272 .to_increment = increment,
273 .to_maxval = increment * 6UL,
276 struct rpc_create_args args = {
277 .protocol = host->h_proto,
278 .address = (struct sockaddr *)&host->h_addr,
279 .addrsize = sizeof(host->h_addr),
280 .saddress = (struct sockaddr *)&host->h_saddr,
281 .timeout = &timeparms,
282 .servername = host->h_name,
283 .program = &nlm_program,
284 .version = host->h_version,
285 .authflavor = RPC_AUTH_UNIX,
286 .flags = (RPC_CLNT_CREATE_NOPING |
287 RPC_CLNT_CREATE_AUTOBIND),
291 * lockd retries server side blocks automatically so we want
292 * those to be soft RPC calls. Client side calls need to be
296 args.flags |= RPC_CLNT_CREATE_HARDRTRY;
298 clnt = rpc_create(&args);
300 host->h_rpcclnt = clnt;
302 printk("lockd: couldn't create RPC handle for %s\n", host->h_name);
307 mutex_unlock(&host->h_mutex);
312 * Force a portmap lookup of the remote lockd port
315 nlm_rebind_host(struct nlm_host *host)
317 dprintk("lockd: rebind host %s\n", host->h_name);
318 if (host->h_rpcclnt && time_after_eq(jiffies, host->h_nextrebind)) {
319 rpc_force_rebind(host->h_rpcclnt);
320 host->h_nextrebind = jiffies + NLM_HOST_REBIND;
325 * Increment NLM host count
327 struct nlm_host * nlm_get_host(struct nlm_host *host)
330 dprintk("lockd: get host %s\n", host->h_name);
331 atomic_inc(&host->h_count);
332 host->h_expires = jiffies + NLM_HOST_EXPIRE;
338 * Release NLM host after use
340 void nlm_release_host(struct nlm_host *host)
343 dprintk("lockd: release host %s\n", host->h_name);
344 BUG_ON(atomic_read(&host->h_count) < 0);
345 if (atomic_dec_and_test(&host->h_count)) {
346 BUG_ON(!list_empty(&host->h_lockowners));
347 BUG_ON(!list_empty(&host->h_granted));
348 BUG_ON(!list_empty(&host->h_reclaim));
354 * We were notified that the host indicated by address &sin
356 * Release all resources held by that peer.
358 void nlm_host_rebooted(const struct sockaddr_in *sin,
359 const char *hostname,
360 unsigned int hostname_len,
363 struct hlist_head *chain;
364 struct hlist_node *pos;
365 struct nsm_handle *nsm;
366 struct nlm_host *host;
368 /* Find the NSM handle for this peer */
369 nsm = __nsm_find(sin, hostname, hostname_len, 0);
371 dprintk("lockd: never saw rebooted peer '%.*s' before\n",
372 hostname_len, hostname);
376 dprintk("lockd: nlm_host_rebooted(%.*s, %s)\n",
377 hostname_len, hostname, nsm->sm_addrbuf);
379 /* When reclaiming locks on this peer, make sure that
380 * we set up a new notification */
381 nsm->sm_monitored = 0;
383 /* Mark all hosts tied to this NSM state as having rebooted.
384 * We run the loop repeatedly, because we drop the host table
386 * To avoid processing a host several times, we match the nsmstate.
388 again: mutex_lock(&nlm_host_mutex);
389 for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
390 hlist_for_each_entry(host, pos, chain, h_hash) {
391 if (host->h_nsmhandle == nsm
392 && host->h_nsmstate != new_state) {
393 host->h_nsmstate = new_state;
397 mutex_unlock(&nlm_host_mutex);
399 if (host->h_server) {
400 /* We're server for this guy, just ditch
401 * all the locks he held. */
402 nlmsvc_free_host_resources(host);
404 /* He's the server, initiate lock recovery. */
405 nlmclnt_recovery(host);
408 nlm_release_host(host);
414 mutex_unlock(&nlm_host_mutex);
418 * Shut down the hosts module.
419 * Note that this routine is called only at server shutdown time.
422 nlm_shutdown_hosts(void)
424 struct hlist_head *chain;
425 struct hlist_node *pos;
426 struct nlm_host *host;
428 dprintk("lockd: shutting down host module\n");
429 mutex_lock(&nlm_host_mutex);
431 /* First, make all hosts eligible for gc */
432 dprintk("lockd: nuking all hosts...\n");
433 for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
434 hlist_for_each_entry(host, pos, chain, h_hash) {
435 host->h_expires = jiffies - 1;
436 if (host->h_rpcclnt) {
437 rpc_shutdown_client(host->h_rpcclnt);
438 host->h_rpcclnt = NULL;
443 /* Then, perform a garbage collection pass */
445 mutex_unlock(&nlm_host_mutex);
447 /* complain if any hosts are left */
449 printk(KERN_WARNING "lockd: couldn't shutdown host module!\n");
450 dprintk("lockd: %d hosts left:\n", nrhosts);
451 for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
452 hlist_for_each_entry(host, pos, chain, h_hash) {
453 dprintk(" %s (cnt %d use %d exp %ld)\n",
454 host->h_name, atomic_read(&host->h_count),
455 host->h_inuse, host->h_expires);
462 * Garbage collect any unused NLM hosts.
463 * This GC combines reference counting for async operations with
464 * mark & sweep for resources held by remote clients.
469 struct hlist_head *chain;
470 struct hlist_node *pos, *next;
471 struct nlm_host *host;
473 dprintk("lockd: host garbage collection\n");
474 for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
475 hlist_for_each_entry(host, pos, chain, h_hash)
479 /* Mark all hosts that hold locks, blocks or shares */
480 nlmsvc_mark_resources();
482 for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
483 hlist_for_each_entry_safe(host, pos, next, chain, h_hash) {
484 if (atomic_read(&host->h_count) || host->h_inuse
485 || time_before(jiffies, host->h_expires)) {
486 dprintk("nlm_gc_hosts skipping %s (cnt %d use %d exp %ld)\n",
487 host->h_name, atomic_read(&host->h_count),
488 host->h_inuse, host->h_expires);
491 dprintk("lockd: delete host %s\n", host->h_name);
492 hlist_del_init(&host->h_hash);
494 nlm_destroy_host(host);
499 next_gc = jiffies + NLM_HOST_COLLECT;
506 static LIST_HEAD(nsm_handles);
507 static DEFINE_SPINLOCK(nsm_lock);
509 static struct nsm_handle *
510 __nsm_find(const struct sockaddr_in *sin,
511 const char *hostname, unsigned int hostname_len,
514 struct nsm_handle *nsm = NULL;
515 struct nsm_handle *pos;
520 if (hostname && memchr(hostname, '/', hostname_len) != NULL) {
521 if (printk_ratelimit()) {
522 printk(KERN_WARNING "Invalid hostname \"%.*s\" "
523 "in NFS lock request\n",
524 hostname_len, hostname);
530 spin_lock(&nsm_lock);
531 list_for_each_entry(pos, &nsm_handles, sm_link) {
533 if (hostname && nsm_use_hostnames) {
534 if (strlen(pos->sm_name) != hostname_len
535 || memcmp(pos->sm_name, hostname, hostname_len))
537 } else if (!nlm_cmp_addr(&pos->sm_addr, sin))
539 atomic_inc(&pos->sm_count);
545 list_add(&nsm->sm_link, &nsm_handles);
548 spin_unlock(&nsm_lock);
553 nsm = kzalloc(sizeof(*nsm) + hostname_len + 1, GFP_KERNEL);
558 nsm->sm_name = (char *) (nsm + 1);
559 memcpy(nsm->sm_name, hostname, hostname_len);
560 nsm->sm_name[hostname_len] = '\0';
561 nlm_display_address((struct sockaddr *)&nsm->sm_addr,
562 nsm->sm_addrbuf, sizeof(nsm->sm_addrbuf));
563 atomic_set(&nsm->sm_count, 1);
567 spin_unlock(&nsm_lock);
571 static struct nsm_handle *
572 nsm_find(const struct sockaddr_in *sin, const char *hostname,
573 unsigned int hostname_len)
575 return __nsm_find(sin, hostname, hostname_len, 1);
579 * Release an NSM handle
582 nsm_release(struct nsm_handle *nsm)
586 if (atomic_dec_and_lock(&nsm->sm_count, &nsm_lock)) {
587 list_del(&nsm->sm_link);
588 spin_unlock(&nsm_lock);