sunrpc: move address copy/cmp/convert routines and prototypes from clnt.h to addr.h
[firefly-linux-kernel-4.4.55.git] / 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/addr.h>
17 #include <linux/sunrpc/svc.h>
18 #include <linux/lockd/lockd.h>
19 #include <linux/mutex.h>
20
21 #include <linux/sunrpc/svc_xprt.h>
22
23 #include <net/ipv6.h>
24
25 #include "netns.h"
26
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)
32
33 static struct hlist_head        nlm_server_hosts[NLM_HOST_NRHASH];
34 static struct hlist_head        nlm_client_hosts[NLM_HOST_NRHASH];
35
36 #define for_each_host(host, pos, chain, table) \
37         for ((chain) = (table); \
38              (chain) < (table) + NLM_HOST_NRHASH; ++(chain)) \
39                 hlist_for_each_entry((host), (pos), (chain), h_hash)
40
41 #define for_each_host_safe(host, pos, next, chain, table) \
42         for ((chain) = (table); \
43              (chain) < (table) + NLM_HOST_NRHASH; ++(chain)) \
44                 hlist_for_each_entry_safe((host), (pos), (next), \
45                                                 (chain), h_hash)
46
47 static unsigned long            nrhosts;
48 static DEFINE_MUTEX(nlm_host_mutex);
49
50 static void                     nlm_gc_hosts(struct net *net);
51
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 */
62 };
63
64 /*
65  * Hash function must work well on big- and little-endian platforms
66  */
67 static unsigned int __nlm_hash32(const __be32 n)
68 {
69         unsigned int hash = (__force u32)n ^ ((__force u32)n >> 16);
70         return hash ^ (hash >> 8);
71 }
72
73 static unsigned int __nlm_hash_addr4(const struct sockaddr *sap)
74 {
75         const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
76         return __nlm_hash32(sin->sin_addr.s_addr);
77 }
78
79 static unsigned int __nlm_hash_addr6(const struct sockaddr *sap)
80 {
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]);
87 }
88
89 static unsigned int nlm_hash_address(const struct sockaddr *sap)
90 {
91         unsigned int hash;
92
93         switch (sap->sa_family) {
94         case AF_INET:
95                 hash = __nlm_hash_addr4(sap);
96                 break;
97         case AF_INET6:
98                 hash = __nlm_hash_addr6(sap);
99                 break;
100         default:
101                 hash = 0;
102         }
103         return hash & (NLM_HOST_NRHASH - 1);
104 }
105
106 /*
107  * Allocate and initialize an nlm_host.  Common to both client and server.
108  */
109 static struct nlm_host *nlm_alloc_host(struct nlm_lookup_host_info *ni,
110                                        struct nsm_handle *nsm)
111 {
112         struct nlm_host *host = NULL;
113         unsigned long now = jiffies;
114
115         if (nsm != NULL)
116                 atomic_inc(&nsm->sm_count);
117         else {
118                 host = NULL;
119                 nsm = nsm_get_handle(ni->sap, ni->salen,
120                                         ni->hostname, ni->hostname_len);
121                 if (unlikely(nsm == NULL)) {
122                         dprintk("lockd: %s failed; no nsm handle\n",
123                                 __func__);
124                         goto out;
125                 }
126         }
127
128         host = kmalloc(sizeof(*host), GFP_KERNEL);
129         if (unlikely(host == NULL)) {
130                 dprintk("lockd: %s failed; no memory\n", __func__);
131                 nsm_release(nsm);
132                 goto out;
133         }
134
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;
139
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;
147         host->h_inuse      = 0;
148         init_waitqueue_head(&host->h_gracewait);
149         init_rwsem(&host->h_rwsem);
150         host->h_state      = 0;
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;
163         host->net          = ni->net;
164
165 out:
166         return host;
167 }
168
169 /*
170  * Destroy an nlm_host and free associated resources
171  *
172  * Caller must hold nlm_host_mutex.
173  */
174 static void nlm_destroy_host_locked(struct nlm_host *host)
175 {
176         struct rpc_clnt *clnt;
177         struct lockd_net *ln = net_generic(host->net, lockd_net_id);
178
179         dprintk("lockd: destroy host %s\n", host->h_name);
180
181         hlist_del_init(&host->h_hash);
182
183         nsm_unmonitor(host);
184         nsm_release(host->h_nsmhandle);
185
186         clnt = host->h_rpcclnt;
187         if (clnt != NULL)
188                 rpc_shutdown_client(clnt);
189         kfree(host);
190
191         ln->nrhosts--;
192         nrhosts--;
193 }
194
195 /**
196  * nlmclnt_lookup_host - Find an NLM host handle matching a remote server
197  * @sap: network address of server
198  * @salen: length of server address
199  * @protocol: transport protocol to use
200  * @version: NLM protocol version
201  * @hostname: '\0'-terminated hostname of server
202  * @noresvport: 1 if non-privileged port should be used
203  *
204  * Returns an nlm_host structure that matches the passed-in
205  * [server address, transport protocol, NLM version, server hostname].
206  * If one doesn't already exist in the host cache, a new handle is
207  * created and returned.
208  */
209 struct nlm_host *nlmclnt_lookup_host(const struct sockaddr *sap,
210                                      const size_t salen,
211                                      const unsigned short protocol,
212                                      const u32 version,
213                                      const char *hostname,
214                                      int noresvport,
215                                      struct net *net)
216 {
217         struct nlm_lookup_host_info ni = {
218                 .server         = 0,
219                 .sap            = sap,
220                 .salen          = salen,
221                 .protocol       = protocol,
222                 .version        = version,
223                 .hostname       = hostname,
224                 .hostname_len   = strlen(hostname),
225                 .noresvport     = noresvport,
226                 .net            = net,
227         };
228         struct hlist_head *chain;
229         struct hlist_node *pos;
230         struct nlm_host *host;
231         struct nsm_handle *nsm = NULL;
232         struct lockd_net *ln = net_generic(net, lockd_net_id);
233
234         dprintk("lockd: %s(host='%s', vers=%u, proto=%s)\n", __func__,
235                         (hostname ? hostname : "<none>"), version,
236                         (protocol == IPPROTO_UDP ? "udp" : "tcp"));
237
238         mutex_lock(&nlm_host_mutex);
239
240         chain = &nlm_client_hosts[nlm_hash_address(sap)];
241         hlist_for_each_entry(host, pos, chain, h_hash) {
242                 if (host->net != net)
243                         continue;
244                 if (!rpc_cmp_addr(nlm_addr(host), sap))
245                         continue;
246
247                 /* Same address. Share an NSM handle if we already have one */
248                 if (nsm == NULL)
249                         nsm = host->h_nsmhandle;
250
251                 if (host->h_proto != protocol)
252                         continue;
253                 if (host->h_version != version)
254                         continue;
255
256                 nlm_get_host(host);
257                 dprintk("lockd: %s found host %s (%s)\n", __func__,
258                         host->h_name, host->h_addrbuf);
259                 goto out;
260         }
261
262         host = nlm_alloc_host(&ni, nsm);
263         if (unlikely(host == NULL))
264                 goto out;
265
266         hlist_add_head(&host->h_hash, chain);
267         ln->nrhosts++;
268         nrhosts++;
269
270         dprintk("lockd: %s created host %s (%s)\n", __func__,
271                 host->h_name, host->h_addrbuf);
272
273 out:
274         mutex_unlock(&nlm_host_mutex);
275         return host;
276 }
277
278 /**
279  * nlmclnt_release_host - release client nlm_host
280  * @host: nlm_host to release
281  *
282  */
283 void nlmclnt_release_host(struct nlm_host *host)
284 {
285         if (host == NULL)
286                 return;
287
288         dprintk("lockd: release client host %s\n", host->h_name);
289
290         WARN_ON_ONCE(host->h_server);
291
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));
296
297                 mutex_lock(&nlm_host_mutex);
298                 nlm_destroy_host_locked(host);
299                 mutex_unlock(&nlm_host_mutex);
300         }
301 }
302
303 /**
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
308  *
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.
313  *
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.
320  */
321 struct nlm_host *nlmsvc_lookup_host(const struct svc_rqst *rqstp,
322                                     const char *hostname,
323                                     const size_t hostname_len)
324 {
325         struct hlist_head *chain;
326         struct hlist_node *pos;
327         struct nlm_host *host = NULL;
328         struct nsm_handle *nsm = NULL;
329         struct sockaddr *src_sap = svc_daddr(rqstp);
330         size_t src_len = rqstp->rq_daddrlen;
331         struct net *net = SVC_NET(rqstp);
332         struct nlm_lookup_host_info ni = {
333                 .server         = 1,
334                 .sap            = svc_addr(rqstp),
335                 .salen          = rqstp->rq_addrlen,
336                 .protocol       = rqstp->rq_prot,
337                 .version        = rqstp->rq_vers,
338                 .hostname       = hostname,
339                 .hostname_len   = hostname_len,
340                 .net            = net,
341         };
342         struct lockd_net *ln = net_generic(net, lockd_net_id);
343
344         dprintk("lockd: %s(host='%*s', vers=%u, proto=%s)\n", __func__,
345                         (int)hostname_len, hostname, rqstp->rq_vers,
346                         (rqstp->rq_prot == IPPROTO_UDP ? "udp" : "tcp"));
347
348         mutex_lock(&nlm_host_mutex);
349
350         if (time_after_eq(jiffies, ln->next_gc))
351                 nlm_gc_hosts(net);
352
353         chain = &nlm_server_hosts[nlm_hash_address(ni.sap)];
354         hlist_for_each_entry(host, pos, chain, h_hash) {
355                 if (host->net != net)
356                         continue;
357                 if (!rpc_cmp_addr(nlm_addr(host), ni.sap))
358                         continue;
359
360                 /* Same address. Share an NSM handle if we already have one */
361                 if (nsm == NULL)
362                         nsm = host->h_nsmhandle;
363
364                 if (host->h_proto != ni.protocol)
365                         continue;
366                 if (host->h_version != ni.version)
367                         continue;
368                 if (!rpc_cmp_addr(nlm_srcaddr(host), src_sap))
369                         continue;
370
371                 /* Move to head of hash chain. */
372                 hlist_del(&host->h_hash);
373                 hlist_add_head(&host->h_hash, chain);
374
375                 nlm_get_host(host);
376                 dprintk("lockd: %s found host %s (%s)\n",
377                         __func__, host->h_name, host->h_addrbuf);
378                 goto out;
379         }
380
381         host = nlm_alloc_host(&ni, nsm);
382         if (unlikely(host == NULL))
383                 goto out;
384
385         memcpy(nlm_srcaddr(host), src_sap, src_len);
386         host->h_srcaddrlen = src_len;
387         hlist_add_head(&host->h_hash, chain);
388         ln->nrhosts++;
389         nrhosts++;
390
391         dprintk("lockd: %s created host %s (%s)\n",
392                 __func__, host->h_name, host->h_addrbuf);
393
394 out:
395         mutex_unlock(&nlm_host_mutex);
396         return host;
397 }
398
399 /**
400  * nlmsvc_release_host - release server nlm_host
401  * @host: nlm_host to release
402  *
403  * Host is destroyed later in nlm_gc_host().
404  */
405 void nlmsvc_release_host(struct nlm_host *host)
406 {
407         if (host == NULL)
408                 return;
409
410         dprintk("lockd: release server host %s\n", host->h_name);
411
412         WARN_ON_ONCE(!host->h_server);
413         atomic_dec(&host->h_count);
414 }
415
416 /*
417  * Create the NLM RPC client for an NLM peer
418  */
419 struct rpc_clnt *
420 nlm_bind_host(struct nlm_host *host)
421 {
422         struct rpc_clnt *clnt;
423
424         dprintk("lockd: nlm_bind_host %s (%s)\n",
425                         host->h_name, host->h_addrbuf);
426
427         /* Lock host handle */
428         mutex_lock(&host->h_mutex);
429
430         /* If we've already created an RPC client, check whether
431          * RPC rebind is required
432          */
433         if ((clnt = host->h_rpcclnt) != NULL) {
434                 if (time_after_eq(jiffies, host->h_nextrebind)) {
435                         rpc_force_rebind(clnt);
436                         host->h_nextrebind = jiffies + NLM_HOST_REBIND;
437                         dprintk("lockd: next rebind in %lu jiffies\n",
438                                         host->h_nextrebind - jiffies);
439                 }
440         } else {
441                 unsigned long increment = nlmsvc_timeout;
442                 struct rpc_timeout timeparms = {
443                         .to_initval     = increment,
444                         .to_increment   = increment,
445                         .to_maxval      = increment * 6UL,
446                         .to_retries     = 5U,
447                 };
448                 struct rpc_create_args args = {
449                         .net            = host->net,
450                         .protocol       = host->h_proto,
451                         .address        = nlm_addr(host),
452                         .addrsize       = host->h_addrlen,
453                         .timeout        = &timeparms,
454                         .servername     = host->h_name,
455                         .program        = &nlm_program,
456                         .version        = host->h_version,
457                         .authflavor     = RPC_AUTH_UNIX,
458                         .flags          = (RPC_CLNT_CREATE_NOPING |
459                                            RPC_CLNT_CREATE_AUTOBIND),
460                 };
461
462                 /*
463                  * lockd retries server side blocks automatically so we want
464                  * those to be soft RPC calls. Client side calls need to be
465                  * hard RPC tasks.
466                  */
467                 if (!host->h_server)
468                         args.flags |= RPC_CLNT_CREATE_HARDRTRY;
469                 if (host->h_noresvport)
470                         args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
471                 if (host->h_srcaddrlen)
472                         args.saddress = nlm_srcaddr(host);
473
474                 clnt = rpc_create(&args);
475                 if (!IS_ERR(clnt))
476                         host->h_rpcclnt = clnt;
477                 else {
478                         printk("lockd: couldn't create RPC handle for %s\n", host->h_name);
479                         clnt = NULL;
480                 }
481         }
482
483         mutex_unlock(&host->h_mutex);
484         return clnt;
485 }
486
487 /*
488  * Force a portmap lookup of the remote lockd port
489  */
490 void
491 nlm_rebind_host(struct nlm_host *host)
492 {
493         dprintk("lockd: rebind host %s\n", host->h_name);
494         if (host->h_rpcclnt && time_after_eq(jiffies, host->h_nextrebind)) {
495                 rpc_force_rebind(host->h_rpcclnt);
496                 host->h_nextrebind = jiffies + NLM_HOST_REBIND;
497         }
498 }
499
500 /*
501  * Increment NLM host count
502  */
503 struct nlm_host * nlm_get_host(struct nlm_host *host)
504 {
505         if (host) {
506                 dprintk("lockd: get host %s\n", host->h_name);
507                 atomic_inc(&host->h_count);
508                 host->h_expires = jiffies + NLM_HOST_EXPIRE;
509         }
510         return host;
511 }
512
513 static struct nlm_host *next_host_state(struct hlist_head *cache,
514                                         struct nsm_handle *nsm,
515                                         const struct nlm_reboot *info)
516 {
517         struct nlm_host *host;
518         struct hlist_head *chain;
519         struct hlist_node *pos;
520
521         mutex_lock(&nlm_host_mutex);
522         for_each_host(host, pos, chain, cache) {
523                 if (host->h_nsmhandle == nsm
524                     && host->h_nsmstate != info->state) {
525                         host->h_nsmstate = info->state;
526                         host->h_state++;
527
528                         nlm_get_host(host);
529                         mutex_unlock(&nlm_host_mutex);
530                         return host;
531                 }
532         }
533
534         mutex_unlock(&nlm_host_mutex);
535         return NULL;
536 }
537
538 /**
539  * nlm_host_rebooted - Release all resources held by rebooted host
540  * @info: pointer to decoded results of NLM_SM_NOTIFY call
541  *
542  * We were notified that the specified host has rebooted.  Release
543  * all resources held by that peer.
544  */
545 void nlm_host_rebooted(const struct nlm_reboot *info)
546 {
547         struct nsm_handle *nsm;
548         struct nlm_host *host;
549
550         nsm = nsm_reboot_lookup(info);
551         if (unlikely(nsm == NULL))
552                 return;
553
554         /* Mark all hosts tied to this NSM state as having rebooted.
555          * We run the loop repeatedly, because we drop the host table
556          * lock for this.
557          * To avoid processing a host several times, we match the nsmstate.
558          */
559         while ((host = next_host_state(nlm_server_hosts, nsm, info)) != NULL) {
560                 nlmsvc_free_host_resources(host);
561                 nlmsvc_release_host(host);
562         }
563         while ((host = next_host_state(nlm_client_hosts, nsm, info)) != NULL) {
564                 nlmclnt_recovery(host);
565                 nlmclnt_release_host(host);
566         }
567
568         nsm_release(nsm);
569 }
570
571 static void nlm_complain_hosts(struct net *net)
572 {
573         struct hlist_head *chain;
574         struct hlist_node *pos;
575         struct nlm_host *host;
576
577         if (net) {
578                 struct lockd_net *ln = net_generic(net, lockd_net_id);
579
580                 if (ln->nrhosts == 0)
581                         return;
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);
584         } else {
585                 if (nrhosts == 0)
586                         return;
587                 printk(KERN_WARNING "lockd: couldn't shutdown host module!\n");
588                 dprintk("lockd: %lu hosts left:\n", nrhosts);
589         }
590
591         for_each_host(host, pos, chain, nlm_server_hosts) {
592                 if (net && host->net != net)
593                         continue;
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);
597         }
598 }
599
600 void
601 nlm_shutdown_hosts_net(struct net *net)
602 {
603         struct hlist_head *chain;
604         struct hlist_node *pos;
605         struct nlm_host *host;
606
607         mutex_lock(&nlm_host_mutex);
608
609         /* First, make all hosts eligible for gc */
610         dprintk("lockd: nuking all hosts in net %p...\n", net);
611         for_each_host(host, pos, chain, nlm_server_hosts) {
612                 if (net && host->net != net)
613                         continue;
614                 host->h_expires = jiffies - 1;
615                 if (host->h_rpcclnt) {
616                         rpc_shutdown_client(host->h_rpcclnt);
617                         host->h_rpcclnt = NULL;
618                 }
619         }
620
621         /* Then, perform a garbage collection pass */
622         nlm_gc_hosts(net);
623         mutex_unlock(&nlm_host_mutex);
624
625         nlm_complain_hosts(net);
626 }
627
628 /*
629  * Shut down the hosts module.
630  * Note that this routine is called only at server shutdown time.
631  */
632 void
633 nlm_shutdown_hosts(void)
634 {
635         dprintk("lockd: shutting down host module\n");
636         nlm_shutdown_hosts_net(NULL);
637 }
638
639 /*
640  * Garbage collect any unused NLM hosts.
641  * This GC combines reference counting for async operations with
642  * mark & sweep for resources held by remote clients.
643  */
644 static void
645 nlm_gc_hosts(struct net *net)
646 {
647         struct hlist_head *chain;
648         struct hlist_node *pos, *next;
649         struct nlm_host *host;
650
651         dprintk("lockd: host garbage collection for net %p\n", net);
652         for_each_host(host, pos, chain, nlm_server_hosts) {
653                 if (net && host->net != net)
654                         continue;
655                 host->h_inuse = 0;
656         }
657
658         /* Mark all hosts that hold locks, blocks or shares */
659         nlmsvc_mark_resources(net);
660
661         for_each_host_safe(host, pos, next, chain, nlm_server_hosts) {
662                 if (net && host->net != net)
663                         continue;
664                 if (atomic_read(&host->h_count) || host->h_inuse
665                  || time_before(jiffies, host->h_expires)) {
666                         dprintk("nlm_gc_hosts skipping %s "
667                                 "(cnt %d use %d exp %ld net %p)\n",
668                                 host->h_name, atomic_read(&host->h_count),
669                                 host->h_inuse, host->h_expires, host->net);
670                         continue;
671                 }
672                 nlm_destroy_host_locked(host);
673         }
674
675         if (net) {
676                 struct lockd_net *ln = net_generic(net, lockd_net_id);
677
678                 ln->next_gc = jiffies + NLM_HOST_COLLECT;
679         }
680 }