]> Pileus Git - ~andy/linux/blob - fs/lockd/host.c
5876b0e4c0bea3d9648f761b4e6fb7774e7de386
[~andy/linux] / fs / lockd / host.c
1 /*
2  * linux/fs/lockd/host.c
3  *
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.
7  *
8  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
9  */
10
11 #include <linux/types.h>
12 #include <linux/slab.h>
13 #include <linux/in.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>
20
21 #include <net/ipv6.h>
22
23 #define NLMDBG_FACILITY         NLMDBG_HOSTCACHE
24 #define NLM_HOST_NRHASH         32
25 #define NLM_HOST_REBIND         (60 * HZ)
26 #define NLM_HOST_EXPIRE         (300 * HZ)
27 #define NLM_HOST_COLLECT        (120 * HZ)
28
29 static struct hlist_head        nlm_hosts[NLM_HOST_NRHASH];
30 static unsigned long            next_gc;
31 static int                      nrhosts;
32 static DEFINE_MUTEX(nlm_host_mutex);
33
34 static void                     nlm_gc_hosts(void);
35 static struct nsm_handle        *nsm_find(const struct sockaddr *sap,
36                                                 const size_t salen,
37                                                 const char *hostname,
38                                                 const size_t hostname_len,
39                                                 const int create);
40
41 struct nlm_lookup_host_info {
42         const int               server;         /* search for server|client */
43         const struct sockaddr   *sap;           /* address to search for */
44         const size_t            salen;          /* it's length */
45         const unsigned short    protocol;       /* transport to search for*/
46         const u32               version;        /* NLM version to search for */
47         const char              *hostname;      /* remote's hostname */
48         const size_t            hostname_len;   /* it's length */
49         const struct sockaddr   *src_sap;       /* our address (optional) */
50         const size_t            src_len;        /* it's length */
51 };
52
53 /*
54  * Hash function must work well on big- and little-endian platforms
55  */
56 static unsigned int __nlm_hash32(const __be32 n)
57 {
58         unsigned int hash = (__force u32)n ^ ((__force u32)n >> 16);
59         return hash ^ (hash >> 8);
60 }
61
62 static unsigned int __nlm_hash_addr4(const struct sockaddr *sap)
63 {
64         const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
65         return __nlm_hash32(sin->sin_addr.s_addr);
66 }
67
68 static unsigned int __nlm_hash_addr6(const struct sockaddr *sap)
69 {
70         const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
71         const struct in6_addr addr = sin6->sin6_addr;
72         return __nlm_hash32(addr.s6_addr32[0]) ^
73                __nlm_hash32(addr.s6_addr32[1]) ^
74                __nlm_hash32(addr.s6_addr32[2]) ^
75                __nlm_hash32(addr.s6_addr32[3]);
76 }
77
78 static unsigned int nlm_hash_address(const struct sockaddr *sap)
79 {
80         unsigned int hash;
81
82         switch (sap->sa_family) {
83         case AF_INET:
84                 hash = __nlm_hash_addr4(sap);
85                 break;
86         case AF_INET6:
87                 hash = __nlm_hash_addr6(sap);
88                 break;
89         default:
90                 hash = 0;
91         }
92         return hash & (NLM_HOST_NRHASH - 1);
93 }
94
95 static void nlm_clear_port(struct sockaddr *sap)
96 {
97         switch (sap->sa_family) {
98         case AF_INET:
99                 ((struct sockaddr_in *)sap)->sin_port = 0;
100                 break;
101         case AF_INET6:
102                 ((struct sockaddr_in6 *)sap)->sin6_port = 0;
103                 break;
104         }
105 }
106
107 static void nlm_display_address(const struct sockaddr *sap,
108                                 char *buf, const size_t len)
109 {
110         const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
111         const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
112
113         switch (sap->sa_family) {
114         case AF_UNSPEC:
115                 snprintf(buf, len, "unspecified");
116                 break;
117         case AF_INET:
118                 snprintf(buf, len, NIPQUAD_FMT, NIPQUAD(sin->sin_addr.s_addr));
119                 break;
120         case AF_INET6:
121                 if (ipv6_addr_v4mapped(&sin6->sin6_addr))
122                         snprintf(buf, len, NIPQUAD_FMT,
123                                  NIPQUAD(sin6->sin6_addr.s6_addr32[3]));
124                 else
125                         snprintf(buf, len, NIP6_FMT, NIP6(sin6->sin6_addr));
126                 break;
127         default:
128                 snprintf(buf, len, "unsupported address family");
129                 break;
130         }
131 }
132
133 /*
134  * Common host lookup routine for server & client
135  */
136 static struct nlm_host *nlm_lookup_host(struct nlm_lookup_host_info *ni)
137 {
138         struct hlist_head *chain;
139         struct hlist_node *pos;
140         struct nlm_host *host;
141         struct nsm_handle *nsm = NULL;
142
143         mutex_lock(&nlm_host_mutex);
144
145         if (time_after_eq(jiffies, next_gc))
146                 nlm_gc_hosts();
147
148         /* We may keep several nlm_host objects for a peer, because each
149          * nlm_host is identified by
150          * (address, protocol, version, server/client)
151          * We could probably simplify this a little by putting all those
152          * different NLM rpc_clients into one single nlm_host object.
153          * This would allow us to have one nlm_host per address.
154          */
155         chain = &nlm_hosts[nlm_hash_address(ni->sap)];
156         hlist_for_each_entry(host, pos, chain, h_hash) {
157                 if (!nlm_cmp_addr(nlm_addr(host), ni->sap))
158                         continue;
159
160                 /* See if we have an NSM handle for this client */
161                 if (!nsm)
162                         nsm = host->h_nsmhandle;
163
164                 if (host->h_proto != ni->protocol)
165                         continue;
166                 if (host->h_version != ni->version)
167                         continue;
168                 if (host->h_server != ni->server)
169                         continue;
170                 if (!nlm_cmp_addr(nlm_srcaddr(host), ni->src_sap))
171                         continue;
172
173                 /* Move to head of hash chain. */
174                 hlist_del(&host->h_hash);
175                 hlist_add_head(&host->h_hash, chain);
176
177                 nlm_get_host(host);
178                 dprintk("lockd: nlm_lookup_host found host %s (%s)\n",
179                                 host->h_name, host->h_addrbuf);
180                 goto out;
181         }
182
183         /*
184          * The host wasn't in our hash table.  If we don't
185          * have an NSM handle for it yet, create one.
186          */
187         if (nsm)
188                 atomic_inc(&nsm->sm_count);
189         else {
190                 host = NULL;
191                 nsm = nsm_find(ni->sap, ni->salen,
192                                 ni->hostname, ni->hostname_len, 1);
193                 if (!nsm) {
194                         dprintk("lockd: nlm_lookup_host failed; "
195                                 "no nsm handle\n");
196                         goto out;
197                 }
198         }
199
200         host = kzalloc(sizeof(*host), GFP_KERNEL);
201         if (!host) {
202                 nsm_release(nsm);
203                 dprintk("lockd: nlm_lookup_host failed; no memory\n");
204                 goto out;
205         }
206         host->h_name       = nsm->sm_name;
207         memcpy(nlm_addr(host), ni->sap, ni->salen);
208         host->h_addrlen = ni->salen;
209         nlm_clear_port(nlm_addr(host));
210         memcpy(nlm_srcaddr(host), ni->src_sap, ni->src_len);
211         host->h_version    = ni->version;
212         host->h_proto      = ni->protocol;
213         host->h_rpcclnt    = NULL;
214         mutex_init(&host->h_mutex);
215         host->h_nextrebind = jiffies + NLM_HOST_REBIND;
216         host->h_expires    = jiffies + NLM_HOST_EXPIRE;
217         atomic_set(&host->h_count, 1);
218         init_waitqueue_head(&host->h_gracewait);
219         init_rwsem(&host->h_rwsem);
220         host->h_state      = 0;                 /* pseudo NSM state */
221         host->h_nsmstate   = 0;                 /* real NSM state */
222         host->h_nsmhandle  = nsm;
223         host->h_server     = ni->server;
224         hlist_add_head(&host->h_hash, chain);
225         INIT_LIST_HEAD(&host->h_lockowners);
226         spin_lock_init(&host->h_lock);
227         INIT_LIST_HEAD(&host->h_granted);
228         INIT_LIST_HEAD(&host->h_reclaim);
229
230         nrhosts++;
231
232         nlm_display_address((struct sockaddr *)&host->h_addr,
233                                 host->h_addrbuf, sizeof(host->h_addrbuf));
234         nlm_display_address((struct sockaddr *)&host->h_srcaddr,
235                                 host->h_srcaddrbuf, sizeof(host->h_srcaddrbuf));
236
237         dprintk("lockd: nlm_lookup_host created host %s\n",
238                         host->h_name);
239
240 out:
241         mutex_unlock(&nlm_host_mutex);
242         return host;
243 }
244
245 /*
246  * Destroy a host
247  */
248 static void
249 nlm_destroy_host(struct nlm_host *host)
250 {
251         struct rpc_clnt *clnt;
252
253         BUG_ON(!list_empty(&host->h_lockowners));
254         BUG_ON(atomic_read(&host->h_count));
255
256         /*
257          * Release NSM handle and unmonitor host.
258          */
259         nsm_unmonitor(host);
260
261         clnt = host->h_rpcclnt;
262         if (clnt != NULL)
263                 rpc_shutdown_client(clnt);
264         kfree(host);
265 }
266
267 /*
268  * Find an NLM server handle in the cache. If there is none, create it.
269  */
270 struct nlm_host *nlmclnt_lookup_host(const struct sockaddr_in *sin,
271                                      int proto, u32 version,
272                                      const char *hostname,
273                                      unsigned int hostname_len)
274 {
275         const struct sockaddr source = {
276                 .sa_family      = AF_UNSPEC,
277         };
278         struct nlm_lookup_host_info ni = {
279                 .server         = 0,
280                 .sap            = (struct sockaddr *)sin,
281                 .salen          = sizeof(*sin),
282                 .protocol       = proto,
283                 .version        = version,
284                 .hostname       = hostname,
285                 .hostname_len   = hostname_len,
286                 .src_sap        = &source,
287                 .src_len        = sizeof(source),
288         };
289
290         dprintk("lockd: %s(host='%s', vers=%u, proto=%s)\n", __func__,
291                         (hostname ? hostname : "<none>"), version,
292                         (proto == IPPROTO_UDP ? "udp" : "tcp"));
293
294         return nlm_lookup_host(&ni);
295 }
296
297 /*
298  * Find an NLM client handle in the cache. If there is none, create it.
299  */
300 struct nlm_host *
301 nlmsvc_lookup_host(struct svc_rqst *rqstp,
302                         const char *hostname, unsigned int hostname_len)
303 {
304         const struct sockaddr_in source = {
305                 .sin_family     = AF_INET,
306                 .sin_addr       = rqstp->rq_daddr.addr,
307         };
308         struct nlm_lookup_host_info ni = {
309                 .server         = 1,
310                 .sap            = svc_addr(rqstp),
311                 .salen          = rqstp->rq_addrlen,
312                 .protocol       = rqstp->rq_prot,
313                 .version        = rqstp->rq_vers,
314                 .hostname       = hostname,
315                 .hostname_len   = hostname_len,
316                 .src_sap        = (struct sockaddr *)&source,
317                 .src_len        = sizeof(source),
318         };
319
320         dprintk("lockd: %s(host='%*s', vers=%u, proto=%s)\n", __func__,
321                         (int)hostname_len, hostname, rqstp->rq_vers,
322                         (rqstp->rq_prot == IPPROTO_UDP ? "udp" : "tcp"));
323
324         return nlm_lookup_host(&ni);
325 }
326
327 /*
328  * Create the NLM RPC client for an NLM peer
329  */
330 struct rpc_clnt *
331 nlm_bind_host(struct nlm_host *host)
332 {
333         struct rpc_clnt *clnt;
334
335         dprintk("lockd: nlm_bind_host %s (%s), my addr=%s\n",
336                         host->h_name, host->h_addrbuf, host->h_srcaddrbuf);
337
338         /* Lock host handle */
339         mutex_lock(&host->h_mutex);
340
341         /* If we've already created an RPC client, check whether
342          * RPC rebind is required
343          */
344         if ((clnt = host->h_rpcclnt) != NULL) {
345                 if (time_after_eq(jiffies, host->h_nextrebind)) {
346                         rpc_force_rebind(clnt);
347                         host->h_nextrebind = jiffies + NLM_HOST_REBIND;
348                         dprintk("lockd: next rebind in %lu jiffies\n",
349                                         host->h_nextrebind - jiffies);
350                 }
351         } else {
352                 unsigned long increment = nlmsvc_timeout;
353                 struct rpc_timeout timeparms = {
354                         .to_initval     = increment,
355                         .to_increment   = increment,
356                         .to_maxval      = increment * 6UL,
357                         .to_retries     = 5U,
358                 };
359                 struct rpc_create_args args = {
360                         .protocol       = host->h_proto,
361                         .address        = nlm_addr(host),
362                         .addrsize       = host->h_addrlen,
363                         .saddress       = nlm_srcaddr(host),
364                         .timeout        = &timeparms,
365                         .servername     = host->h_name,
366                         .program        = &nlm_program,
367                         .version        = host->h_version,
368                         .authflavor     = RPC_AUTH_UNIX,
369                         .flags          = (RPC_CLNT_CREATE_NOPING |
370                                            RPC_CLNT_CREATE_AUTOBIND),
371                 };
372
373                 /*
374                  * lockd retries server side blocks automatically so we want
375                  * those to be soft RPC calls. Client side calls need to be
376                  * hard RPC tasks.
377                  */
378                 if (!host->h_server)
379                         args.flags |= RPC_CLNT_CREATE_HARDRTRY;
380
381                 clnt = rpc_create(&args);
382                 if (!IS_ERR(clnt))
383                         host->h_rpcclnt = clnt;
384                 else {
385                         printk("lockd: couldn't create RPC handle for %s\n", host->h_name);
386                         clnt = NULL;
387                 }
388         }
389
390         mutex_unlock(&host->h_mutex);
391         return clnt;
392 }
393
394 /*
395  * Force a portmap lookup of the remote lockd port
396  */
397 void
398 nlm_rebind_host(struct nlm_host *host)
399 {
400         dprintk("lockd: rebind host %s\n", host->h_name);
401         if (host->h_rpcclnt && time_after_eq(jiffies, host->h_nextrebind)) {
402                 rpc_force_rebind(host->h_rpcclnt);
403                 host->h_nextrebind = jiffies + NLM_HOST_REBIND;
404         }
405 }
406
407 /*
408  * Increment NLM host count
409  */
410 struct nlm_host * nlm_get_host(struct nlm_host *host)
411 {
412         if (host) {
413                 dprintk("lockd: get host %s\n", host->h_name);
414                 atomic_inc(&host->h_count);
415                 host->h_expires = jiffies + NLM_HOST_EXPIRE;
416         }
417         return host;
418 }
419
420 /*
421  * Release NLM host after use
422  */
423 void nlm_release_host(struct nlm_host *host)
424 {
425         if (host != NULL) {
426                 dprintk("lockd: release host %s\n", host->h_name);
427                 BUG_ON(atomic_read(&host->h_count) < 0);
428                 if (atomic_dec_and_test(&host->h_count)) {
429                         BUG_ON(!list_empty(&host->h_lockowners));
430                         BUG_ON(!list_empty(&host->h_granted));
431                         BUG_ON(!list_empty(&host->h_reclaim));
432                 }
433         }
434 }
435
436 /*
437  * We were notified that the host indicated by address &sin
438  * has rebooted.
439  * Release all resources held by that peer.
440  */
441 void nlm_host_rebooted(const struct sockaddr_in *sin,
442                                 const char *hostname,
443                                 unsigned int hostname_len,
444                                 u32 new_state)
445 {
446         struct hlist_head *chain;
447         struct hlist_node *pos;
448         struct nsm_handle *nsm;
449         struct nlm_host *host;
450
451         nsm = nsm_find((struct sockaddr *)sin, sizeof(*sin),
452                         hostname, hostname_len, 0);
453         if (nsm == NULL) {
454                 dprintk("lockd: never saw rebooted peer '%.*s' before\n",
455                                 hostname_len, hostname);
456                 return;
457         }
458
459         dprintk("lockd: nlm_host_rebooted(%.*s, %s)\n",
460                         hostname_len, hostname, nsm->sm_addrbuf);
461
462         /* When reclaiming locks on this peer, make sure that
463          * we set up a new notification */
464         nsm->sm_monitored = 0;
465
466         /* Mark all hosts tied to this NSM state as having rebooted.
467          * We run the loop repeatedly, because we drop the host table
468          * lock for this.
469          * To avoid processing a host several times, we match the nsmstate.
470          */
471 again:  mutex_lock(&nlm_host_mutex);
472         for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
473                 hlist_for_each_entry(host, pos, chain, h_hash) {
474                         if (host->h_nsmhandle == nsm
475                          && host->h_nsmstate != new_state) {
476                                 host->h_nsmstate = new_state;
477                                 host->h_state++;
478
479                                 nlm_get_host(host);
480                                 mutex_unlock(&nlm_host_mutex);
481
482                                 if (host->h_server) {
483                                         /* We're server for this guy, just ditch
484                                          * all the locks he held. */
485                                         nlmsvc_free_host_resources(host);
486                                 } else {
487                                         /* He's the server, initiate lock recovery. */
488                                         nlmclnt_recovery(host);
489                                 }
490
491                                 nlm_release_host(host);
492                                 goto again;
493                         }
494                 }
495         }
496
497         mutex_unlock(&nlm_host_mutex);
498 }
499
500 /*
501  * Shut down the hosts module.
502  * Note that this routine is called only at server shutdown time.
503  */
504 void
505 nlm_shutdown_hosts(void)
506 {
507         struct hlist_head *chain;
508         struct hlist_node *pos;
509         struct nlm_host *host;
510
511         dprintk("lockd: shutting down host module\n");
512         mutex_lock(&nlm_host_mutex);
513
514         /* First, make all hosts eligible for gc */
515         dprintk("lockd: nuking all hosts...\n");
516         for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
517                 hlist_for_each_entry(host, pos, chain, h_hash) {
518                         host->h_expires = jiffies - 1;
519                         if (host->h_rpcclnt) {
520                                 rpc_shutdown_client(host->h_rpcclnt);
521                                 host->h_rpcclnt = NULL;
522                         }
523                 }
524         }
525
526         /* Then, perform a garbage collection pass */
527         nlm_gc_hosts();
528         mutex_unlock(&nlm_host_mutex);
529
530         /* complain if any hosts are left */
531         if (nrhosts) {
532                 printk(KERN_WARNING "lockd: couldn't shutdown host module!\n");
533                 dprintk("lockd: %d hosts left:\n", nrhosts);
534                 for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
535                         hlist_for_each_entry(host, pos, chain, h_hash) {
536                                 dprintk("       %s (cnt %d use %d exp %ld)\n",
537                                         host->h_name, atomic_read(&host->h_count),
538                                         host->h_inuse, host->h_expires);
539                         }
540                 }
541         }
542 }
543
544 /*
545  * Garbage collect any unused NLM hosts.
546  * This GC combines reference counting for async operations with
547  * mark & sweep for resources held by remote clients.
548  */
549 static void
550 nlm_gc_hosts(void)
551 {
552         struct hlist_head *chain;
553         struct hlist_node *pos, *next;
554         struct nlm_host *host;
555
556         dprintk("lockd: host garbage collection\n");
557         for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
558                 hlist_for_each_entry(host, pos, chain, h_hash)
559                         host->h_inuse = 0;
560         }
561
562         /* Mark all hosts that hold locks, blocks or shares */
563         nlmsvc_mark_resources();
564
565         for (chain = nlm_hosts; chain < nlm_hosts + NLM_HOST_NRHASH; ++chain) {
566                 hlist_for_each_entry_safe(host, pos, next, chain, h_hash) {
567                         if (atomic_read(&host->h_count) || host->h_inuse
568                          || time_before(jiffies, host->h_expires)) {
569                                 dprintk("nlm_gc_hosts skipping %s (cnt %d use %d exp %ld)\n",
570                                         host->h_name, atomic_read(&host->h_count),
571                                         host->h_inuse, host->h_expires);
572                                 continue;
573                         }
574                         dprintk("lockd: delete host %s\n", host->h_name);
575                         hlist_del_init(&host->h_hash);
576
577                         nlm_destroy_host(host);
578                         nrhosts--;
579                 }
580         }
581
582         next_gc = jiffies + NLM_HOST_COLLECT;
583 }
584
585
586 /*
587  * Manage NSM handles
588  */
589 static LIST_HEAD(nsm_handles);
590 static DEFINE_SPINLOCK(nsm_lock);
591
592 static struct nsm_handle *nsm_find(const struct sockaddr *sap,
593                                    const size_t salen,
594                                    const char *hostname,
595                                    const size_t hostname_len,
596                                    const int create)
597 {
598         struct nsm_handle *nsm = NULL;
599         struct nsm_handle *pos;
600
601         if (!sap)
602                 return NULL;
603
604         if (hostname && memchr(hostname, '/', hostname_len) != NULL) {
605                 if (printk_ratelimit()) {
606                         printk(KERN_WARNING "Invalid hostname \"%.*s\" "
607                                             "in NFS lock request\n",
608                                 (int)hostname_len, hostname);
609                 }
610                 return NULL;
611         }
612
613 retry:
614         spin_lock(&nsm_lock);
615         list_for_each_entry(pos, &nsm_handles, sm_link) {
616
617                 if (hostname && nsm_use_hostnames) {
618                         if (strlen(pos->sm_name) != hostname_len
619                          || memcmp(pos->sm_name, hostname, hostname_len))
620                                 continue;
621                 } else if (!nlm_cmp_addr(nsm_addr(pos), sap))
622                         continue;
623                 atomic_inc(&pos->sm_count);
624                 kfree(nsm);
625                 nsm = pos;
626                 goto found;
627         }
628         if (nsm) {
629                 list_add(&nsm->sm_link, &nsm_handles);
630                 goto found;
631         }
632         spin_unlock(&nsm_lock);
633
634         if (!create)
635                 return NULL;
636
637         nsm = kzalloc(sizeof(*nsm) + hostname_len + 1, GFP_KERNEL);
638         if (nsm == NULL)
639                 return NULL;
640
641         memcpy(nsm_addr(nsm), sap, salen);
642         nsm->sm_addrlen = salen;
643         nsm->sm_name = (char *) (nsm + 1);
644         memcpy(nsm->sm_name, hostname, hostname_len);
645         nsm->sm_name[hostname_len] = '\0';
646         nlm_display_address((struct sockaddr *)&nsm->sm_addr,
647                                 nsm->sm_addrbuf, sizeof(nsm->sm_addrbuf));
648         atomic_set(&nsm->sm_count, 1);
649         goto retry;
650
651 found:
652         spin_unlock(&nsm_lock);
653         return nsm;
654 }
655
656 /*
657  * Release an NSM handle
658  */
659 void
660 nsm_release(struct nsm_handle *nsm)
661 {
662         if (!nsm)
663                 return;
664         if (atomic_dec_and_lock(&nsm->sm_count, &nsm_lock)) {
665                 list_del(&nsm->sm_link);
666                 spin_unlock(&nsm_lock);
667                 kfree(nsm);
668         }
669 }