nfs4: copy acceptor name from context to nfs_client
[linux-2.6-block.git] / fs / nfs / client.c
1 /* client.c: NFS client sharing and management code
2  *
3  * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
4  * Written by David Howells (dhowells@redhat.com)
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version
9  * 2 of the License, or (at your option) any later version.
10  */
11
12
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/sched.h>
16 #include <linux/time.h>
17 #include <linux/kernel.h>
18 #include <linux/mm.h>
19 #include <linux/string.h>
20 #include <linux/stat.h>
21 #include <linux/errno.h>
22 #include <linux/unistd.h>
23 #include <linux/sunrpc/clnt.h>
24 #include <linux/sunrpc/stats.h>
25 #include <linux/sunrpc/metrics.h>
26 #include <linux/sunrpc/xprtsock.h>
27 #include <linux/sunrpc/xprtrdma.h>
28 #include <linux/nfs_fs.h>
29 #include <linux/nfs_mount.h>
30 #include <linux/nfs4_mount.h>
31 #include <linux/lockd/bind.h>
32 #include <linux/seq_file.h>
33 #include <linux/mount.h>
34 #include <linux/nfs_idmap.h>
35 #include <linux/vfs.h>
36 #include <linux/inet.h>
37 #include <linux/in6.h>
38 #include <linux/slab.h>
39 #include <linux/idr.h>
40 #include <net/ipv6.h>
41 #include <linux/nfs_xdr.h>
42 #include <linux/sunrpc/bc_xprt.h>
43 #include <linux/nsproxy.h>
44 #include <linux/pid_namespace.h>
45
46
47 #include "nfs4_fs.h"
48 #include "callback.h"
49 #include "delegation.h"
50 #include "iostat.h"
51 #include "internal.h"
52 #include "fscache.h"
53 #include "pnfs.h"
54 #include "nfs.h"
55 #include "netns.h"
56
57 #define NFSDBG_FACILITY         NFSDBG_CLIENT
58
59 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
60 static DEFINE_SPINLOCK(nfs_version_lock);
61 static DEFINE_MUTEX(nfs_version_mutex);
62 static LIST_HEAD(nfs_versions);
63
64 /*
65  * RPC cruft for NFS
66  */
67 static const struct rpc_version *nfs_version[5] = {
68         [2] = NULL,
69         [3] = NULL,
70         [4] = NULL,
71 };
72
73 const struct rpc_program nfs_program = {
74         .name                   = "nfs",
75         .number                 = NFS_PROGRAM,
76         .nrvers                 = ARRAY_SIZE(nfs_version),
77         .version                = nfs_version,
78         .stats                  = &nfs_rpcstat,
79         .pipe_dir_name          = NFS_PIPE_DIRNAME,
80 };
81
82 struct rpc_stat nfs_rpcstat = {
83         .program                = &nfs_program
84 };
85
86 static struct nfs_subversion *find_nfs_version(unsigned int version)
87 {
88         struct nfs_subversion *nfs;
89         spin_lock(&nfs_version_lock);
90
91         list_for_each_entry(nfs, &nfs_versions, list) {
92                 if (nfs->rpc_ops->version == version) {
93                         spin_unlock(&nfs_version_lock);
94                         return nfs;
95                 }
96         }
97
98         spin_unlock(&nfs_version_lock);
99         return ERR_PTR(-EPROTONOSUPPORT);
100 }
101
102 struct nfs_subversion *get_nfs_version(unsigned int version)
103 {
104         struct nfs_subversion *nfs = find_nfs_version(version);
105
106         if (IS_ERR(nfs)) {
107                 mutex_lock(&nfs_version_mutex);
108                 request_module("nfsv%d", version);
109                 nfs = find_nfs_version(version);
110                 mutex_unlock(&nfs_version_mutex);
111         }
112
113         if (!IS_ERR(nfs))
114                 try_module_get(nfs->owner);
115         return nfs;
116 }
117
118 void put_nfs_version(struct nfs_subversion *nfs)
119 {
120         module_put(nfs->owner);
121 }
122
123 void register_nfs_version(struct nfs_subversion *nfs)
124 {
125         spin_lock(&nfs_version_lock);
126
127         list_add(&nfs->list, &nfs_versions);
128         nfs_version[nfs->rpc_ops->version] = nfs->rpc_vers;
129
130         spin_unlock(&nfs_version_lock);
131 }
132 EXPORT_SYMBOL_GPL(register_nfs_version);
133
134 void unregister_nfs_version(struct nfs_subversion *nfs)
135 {
136         spin_lock(&nfs_version_lock);
137
138         nfs_version[nfs->rpc_ops->version] = NULL;
139         list_del(&nfs->list);
140
141         spin_unlock(&nfs_version_lock);
142 }
143 EXPORT_SYMBOL_GPL(unregister_nfs_version);
144
145 /*
146  * Allocate a shared client record
147  *
148  * Since these are allocated/deallocated very rarely, we don't
149  * bother putting them in a slab cache...
150  */
151 struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
152 {
153         struct nfs_client *clp;
154         struct rpc_cred *cred;
155         int err = -ENOMEM;
156
157         if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
158                 goto error_0;
159
160         clp->cl_nfs_mod = cl_init->nfs_mod;
161         try_module_get(clp->cl_nfs_mod->owner);
162
163         clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
164
165         atomic_set(&clp->cl_count, 1);
166         clp->cl_cons_state = NFS_CS_INITING;
167
168         memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
169         clp->cl_addrlen = cl_init->addrlen;
170
171         if (cl_init->hostname) {
172                 err = -ENOMEM;
173                 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
174                 if (!clp->cl_hostname)
175                         goto error_cleanup;
176         }
177
178         INIT_LIST_HEAD(&clp->cl_superblocks);
179         clp->cl_rpcclient = ERR_PTR(-EINVAL);
180
181         clp->cl_proto = cl_init->proto;
182         clp->cl_net = get_net(cl_init->net);
183
184         cred = rpc_lookup_machine_cred("*");
185         if (!IS_ERR(cred))
186                 clp->cl_machine_cred = cred;
187         nfs_fscache_get_client_cookie(clp);
188
189         return clp;
190
191 error_cleanup:
192         put_nfs_version(clp->cl_nfs_mod);
193         kfree(clp);
194 error_0:
195         return ERR_PTR(err);
196 }
197 EXPORT_SYMBOL_GPL(nfs_alloc_client);
198
199 #if IS_ENABLED(CONFIG_NFS_V4)
200 void nfs_cleanup_cb_ident_idr(struct net *net)
201 {
202         struct nfs_net *nn = net_generic(net, nfs_net_id);
203
204         idr_destroy(&nn->cb_ident_idr);
205 }
206
207 /* nfs_client_lock held */
208 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
209 {
210         struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
211
212         if (clp->cl_cb_ident)
213                 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
214 }
215
216 static void pnfs_init_server(struct nfs_server *server)
217 {
218         rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
219 }
220
221 #else
222 void nfs_cleanup_cb_ident_idr(struct net *net)
223 {
224 }
225
226 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
227 {
228 }
229
230 static void pnfs_init_server(struct nfs_server *server)
231 {
232 }
233
234 #endif /* CONFIG_NFS_V4 */
235
236 /*
237  * Destroy a shared client record
238  */
239 void nfs_free_client(struct nfs_client *clp)
240 {
241         dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
242
243         nfs_fscache_release_client_cookie(clp);
244
245         /* -EIO all pending I/O */
246         if (!IS_ERR(clp->cl_rpcclient))
247                 rpc_shutdown_client(clp->cl_rpcclient);
248
249         if (clp->cl_machine_cred != NULL)
250                 put_rpccred(clp->cl_machine_cred);
251
252         put_net(clp->cl_net);
253         put_nfs_version(clp->cl_nfs_mod);
254         kfree(clp->cl_hostname);
255         kfree(clp->cl_acceptor);
256         kfree(clp);
257
258         dprintk("<-- nfs_free_client()\n");
259 }
260 EXPORT_SYMBOL_GPL(nfs_free_client);
261
262 /*
263  * Release a reference to a shared client record
264  */
265 void nfs_put_client(struct nfs_client *clp)
266 {
267         struct nfs_net *nn;
268
269         if (!clp)
270                 return;
271
272         dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
273         nn = net_generic(clp->cl_net, nfs_net_id);
274
275         if (atomic_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
276                 list_del(&clp->cl_share_link);
277                 nfs_cb_idr_remove_locked(clp);
278                 spin_unlock(&nn->nfs_client_lock);
279
280                 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
281
282                 clp->rpc_ops->free_client(clp);
283         }
284 }
285 EXPORT_SYMBOL_GPL(nfs_put_client);
286
287 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
288 /*
289  * Test if two ip6 socket addresses refer to the same socket by
290  * comparing relevant fields. The padding bytes specifically, are not
291  * compared. sin6_flowinfo is not compared because it only affects QoS
292  * and sin6_scope_id is only compared if the address is "link local"
293  * because "link local" addresses need only be unique to a specific
294  * link. Conversely, ordinary unicast addresses might have different
295  * sin6_scope_id.
296  *
297  * The caller should ensure both socket addresses are AF_INET6.
298  */
299 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
300                                       const struct sockaddr *sa2)
301 {
302         const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
303         const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
304
305         if (!ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr))
306                 return 0;
307         else if (ipv6_addr_type(&sin1->sin6_addr) & IPV6_ADDR_LINKLOCAL)
308                 return sin1->sin6_scope_id == sin2->sin6_scope_id;
309
310         return 1;
311 }
312 #else   /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
313 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
314                                       const struct sockaddr *sa2)
315 {
316         return 0;
317 }
318 #endif
319
320 /*
321  * Test if two ip4 socket addresses refer to the same socket, by
322  * comparing relevant fields. The padding bytes specifically, are
323  * not compared.
324  *
325  * The caller should ensure both socket addresses are AF_INET.
326  */
327 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr *sa1,
328                                       const struct sockaddr *sa2)
329 {
330         const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
331         const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
332
333         return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
334 }
335
336 static int nfs_sockaddr_cmp_ip6(const struct sockaddr *sa1,
337                                 const struct sockaddr *sa2)
338 {
339         const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
340         const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
341
342         return nfs_sockaddr_match_ipaddr6(sa1, sa2) &&
343                 (sin1->sin6_port == sin2->sin6_port);
344 }
345
346 static int nfs_sockaddr_cmp_ip4(const struct sockaddr *sa1,
347                                 const struct sockaddr *sa2)
348 {
349         const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
350         const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
351
352         return nfs_sockaddr_match_ipaddr4(sa1, sa2) &&
353                 (sin1->sin_port == sin2->sin_port);
354 }
355
356 #if defined(CONFIG_NFS_V4_1)
357 /*
358  * Test if two socket addresses represent the same actual socket,
359  * by comparing (only) relevant fields, excluding the port number.
360  */
361 int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
362                               const struct sockaddr *sa2)
363 {
364         if (sa1->sa_family != sa2->sa_family)
365                 return 0;
366
367         switch (sa1->sa_family) {
368         case AF_INET:
369                 return nfs_sockaddr_match_ipaddr4(sa1, sa2);
370         case AF_INET6:
371                 return nfs_sockaddr_match_ipaddr6(sa1, sa2);
372         }
373         return 0;
374 }
375 EXPORT_SYMBOL_GPL(nfs_sockaddr_match_ipaddr);
376 #endif /* CONFIG_NFS_V4_1 */
377
378 /*
379  * Test if two socket addresses represent the same actual socket,
380  * by comparing (only) relevant fields, including the port number.
381  */
382 static int nfs_sockaddr_cmp(const struct sockaddr *sa1,
383                             const struct sockaddr *sa2)
384 {
385         if (sa1->sa_family != sa2->sa_family)
386                 return 0;
387
388         switch (sa1->sa_family) {
389         case AF_INET:
390                 return nfs_sockaddr_cmp_ip4(sa1, sa2);
391         case AF_INET6:
392                 return nfs_sockaddr_cmp_ip6(sa1, sa2);
393         }
394         return 0;
395 }
396
397 /*
398  * Find an nfs_client on the list that matches the initialisation data
399  * that is supplied.
400  */
401 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
402 {
403         struct nfs_client *clp;
404         const struct sockaddr *sap = data->addr;
405         struct nfs_net *nn = net_generic(data->net, nfs_net_id);
406
407         list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
408                 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
409                 /* Don't match clients that failed to initialise properly */
410                 if (clp->cl_cons_state < 0)
411                         continue;
412
413                 /* Different NFS versions cannot share the same nfs_client */
414                 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
415                         continue;
416
417                 if (clp->cl_proto != data->proto)
418                         continue;
419                 /* Match nfsv4 minorversion */
420                 if (clp->cl_minorversion != data->minorversion)
421                         continue;
422                 /* Match the full socket address */
423                 if (!nfs_sockaddr_cmp(sap, clap))
424                         continue;
425
426                 atomic_inc(&clp->cl_count);
427                 return clp;
428         }
429         return NULL;
430 }
431
432 static bool nfs_client_init_is_complete(const struct nfs_client *clp)
433 {
434         return clp->cl_cons_state != NFS_CS_INITING;
435 }
436
437 int nfs_wait_client_init_complete(const struct nfs_client *clp)
438 {
439         return wait_event_killable(nfs_client_active_wq,
440                         nfs_client_init_is_complete(clp));
441 }
442 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
443
444 /*
445  * Found an existing client.  Make sure it's ready before returning.
446  */
447 static struct nfs_client *
448 nfs_found_client(const struct nfs_client_initdata *cl_init,
449                  struct nfs_client *clp)
450 {
451         int error;
452
453         error = nfs_wait_client_init_complete(clp);
454         if (error < 0) {
455                 nfs_put_client(clp);
456                 return ERR_PTR(-ERESTARTSYS);
457         }
458
459         if (clp->cl_cons_state < NFS_CS_READY) {
460                 error = clp->cl_cons_state;
461                 nfs_put_client(clp);
462                 return ERR_PTR(error);
463         }
464
465         smp_rmb();
466
467         dprintk("<-- %s found nfs_client %p for %s\n",
468                 __func__, clp, cl_init->hostname ?: "");
469         return clp;
470 }
471
472 /*
473  * Look up a client by IP address and protocol version
474  * - creates a new record if one doesn't yet exist
475  */
476 struct nfs_client *
477 nfs_get_client(const struct nfs_client_initdata *cl_init,
478                const struct rpc_timeout *timeparms,
479                const char *ip_addr,
480                rpc_authflavor_t authflavour)
481 {
482         struct nfs_client *clp, *new = NULL;
483         struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
484         const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
485
486         if (cl_init->hostname == NULL) {
487                 WARN_ON(1);
488                 return NULL;
489         }
490
491         dprintk("--> nfs_get_client(%s,v%u)\n",
492                 cl_init->hostname, rpc_ops->version);
493
494         /* see if the client already exists */
495         do {
496                 spin_lock(&nn->nfs_client_lock);
497
498                 clp = nfs_match_client(cl_init);
499                 if (clp) {
500                         spin_unlock(&nn->nfs_client_lock);
501                         if (new)
502                                 new->rpc_ops->free_client(new);
503                         return nfs_found_client(cl_init, clp);
504                 }
505                 if (new) {
506                         list_add_tail(&new->cl_share_link,
507                                         &nn->nfs_client_list);
508                         spin_unlock(&nn->nfs_client_lock);
509                         new->cl_flags = cl_init->init_flags;
510                         return rpc_ops->init_client(new, timeparms, ip_addr);
511                 }
512
513                 spin_unlock(&nn->nfs_client_lock);
514
515                 new = rpc_ops->alloc_client(cl_init);
516         } while (!IS_ERR(new));
517
518         dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
519                 cl_init->hostname, PTR_ERR(new));
520         return new;
521 }
522 EXPORT_SYMBOL_GPL(nfs_get_client);
523
524 /*
525  * Mark a server as ready or failed
526  */
527 void nfs_mark_client_ready(struct nfs_client *clp, int state)
528 {
529         smp_wmb();
530         clp->cl_cons_state = state;
531         wake_up_all(&nfs_client_active_wq);
532 }
533 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
534
535 /*
536  * Initialise the timeout values for a connection
537  */
538 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
539                                     unsigned int timeo, unsigned int retrans)
540 {
541         to->to_initval = timeo * HZ / 10;
542         to->to_retries = retrans;
543
544         switch (proto) {
545         case XPRT_TRANSPORT_TCP:
546         case XPRT_TRANSPORT_RDMA:
547                 if (to->to_retries == 0)
548                         to->to_retries = NFS_DEF_TCP_RETRANS;
549                 if (to->to_initval == 0)
550                         to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
551                 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
552                         to->to_initval = NFS_MAX_TCP_TIMEOUT;
553                 to->to_increment = to->to_initval;
554                 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
555                 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
556                         to->to_maxval = NFS_MAX_TCP_TIMEOUT;
557                 if (to->to_maxval < to->to_initval)
558                         to->to_maxval = to->to_initval;
559                 to->to_exponential = 0;
560                 break;
561         case XPRT_TRANSPORT_UDP:
562                 if (to->to_retries == 0)
563                         to->to_retries = NFS_DEF_UDP_RETRANS;
564                 if (!to->to_initval)
565                         to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
566                 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
567                         to->to_initval = NFS_MAX_UDP_TIMEOUT;
568                 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
569                 to->to_exponential = 1;
570                 break;
571         default:
572                 BUG();
573         }
574 }
575 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
576
577 /*
578  * Create an RPC client handle
579  */
580 int nfs_create_rpc_client(struct nfs_client *clp,
581                           const struct rpc_timeout *timeparms,
582                           rpc_authflavor_t flavor)
583 {
584         struct rpc_clnt         *clnt = NULL;
585         struct rpc_create_args args = {
586                 .net            = clp->cl_net,
587                 .protocol       = clp->cl_proto,
588                 .address        = (struct sockaddr *)&clp->cl_addr,
589                 .addrsize       = clp->cl_addrlen,
590                 .timeout        = timeparms,
591                 .servername     = clp->cl_hostname,
592                 .program        = &nfs_program,
593                 .version        = clp->rpc_ops->version,
594                 .authflavor     = flavor,
595         };
596
597         if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
598                 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
599         if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
600                 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
601         if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
602                 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
603         if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
604                 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
605
606         if (!IS_ERR(clp->cl_rpcclient))
607                 return 0;
608
609         clnt = rpc_create(&args);
610         if (IS_ERR(clnt)) {
611                 dprintk("%s: cannot create RPC client. Error = %ld\n",
612                                 __func__, PTR_ERR(clnt));
613                 return PTR_ERR(clnt);
614         }
615
616         clp->cl_rpcclient = clnt;
617         return 0;
618 }
619 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
620
621 /*
622  * Version 2 or 3 client destruction
623  */
624 static void nfs_destroy_server(struct nfs_server *server)
625 {
626         if (server->nlm_host)
627                 nlmclnt_done(server->nlm_host);
628 }
629
630 /*
631  * Version 2 or 3 lockd setup
632  */
633 static int nfs_start_lockd(struct nfs_server *server)
634 {
635         struct nlm_host *host;
636         struct nfs_client *clp = server->nfs_client;
637         struct nlmclnt_initdata nlm_init = {
638                 .hostname       = clp->cl_hostname,
639                 .address        = (struct sockaddr *)&clp->cl_addr,
640                 .addrlen        = clp->cl_addrlen,
641                 .nfs_version    = clp->rpc_ops->version,
642                 .noresvport     = server->flags & NFS_MOUNT_NORESVPORT ?
643                                         1 : 0,
644                 .net            = clp->cl_net,
645         };
646
647         if (nlm_init.nfs_version > 3)
648                 return 0;
649         if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
650                         (server->flags & NFS_MOUNT_LOCAL_FCNTL))
651                 return 0;
652
653         switch (clp->cl_proto) {
654                 default:
655                         nlm_init.protocol = IPPROTO_TCP;
656                         break;
657                 case XPRT_TRANSPORT_UDP:
658                         nlm_init.protocol = IPPROTO_UDP;
659         }
660
661         host = nlmclnt_init(&nlm_init);
662         if (IS_ERR(host))
663                 return PTR_ERR(host);
664
665         server->nlm_host = host;
666         server->destroy = nfs_destroy_server;
667         return 0;
668 }
669
670 /*
671  * Create a general RPC client
672  */
673 int nfs_init_server_rpcclient(struct nfs_server *server,
674                 const struct rpc_timeout *timeo,
675                 rpc_authflavor_t pseudoflavour)
676 {
677         struct nfs_client *clp = server->nfs_client;
678
679         server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
680                                                         pseudoflavour);
681         if (IS_ERR(server->client)) {
682                 dprintk("%s: couldn't create rpc_client!\n", __func__);
683                 return PTR_ERR(server->client);
684         }
685
686         memcpy(&server->client->cl_timeout_default,
687                         timeo,
688                         sizeof(server->client->cl_timeout_default));
689         server->client->cl_timeout = &server->client->cl_timeout_default;
690         server->client->cl_softrtry = 0;
691         if (server->flags & NFS_MOUNT_SOFT)
692                 server->client->cl_softrtry = 1;
693
694         return 0;
695 }
696 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
697
698 /**
699  * nfs_init_client - Initialise an NFS2 or NFS3 client
700  *
701  * @clp: nfs_client to initialise
702  * @timeparms: timeout parameters for underlying RPC transport
703  * @ip_addr: IP presentation address (not used)
704  *
705  * Returns pointer to an NFS client, or an ERR_PTR value.
706  */
707 struct nfs_client *nfs_init_client(struct nfs_client *clp,
708                     const struct rpc_timeout *timeparms,
709                     const char *ip_addr)
710 {
711         int error;
712
713         if (clp->cl_cons_state == NFS_CS_READY) {
714                 /* the client is already initialised */
715                 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
716                 return clp;
717         }
718
719         /*
720          * Create a client RPC handle for doing FSSTAT with UNIX auth only
721          * - RFC 2623, sec 2.3.2
722          */
723         error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX);
724         if (error < 0)
725                 goto error;
726         nfs_mark_client_ready(clp, NFS_CS_READY);
727         return clp;
728
729 error:
730         nfs_mark_client_ready(clp, error);
731         nfs_put_client(clp);
732         dprintk("<-- nfs_init_client() = xerror %d\n", error);
733         return ERR_PTR(error);
734 }
735 EXPORT_SYMBOL_GPL(nfs_init_client);
736
737 /*
738  * Create a version 2 or 3 client
739  */
740 static int nfs_init_server(struct nfs_server *server,
741                            const struct nfs_parsed_mount_data *data,
742                            struct nfs_subversion *nfs_mod)
743 {
744         struct nfs_client_initdata cl_init = {
745                 .hostname = data->nfs_server.hostname,
746                 .addr = (const struct sockaddr *)&data->nfs_server.address,
747                 .addrlen = data->nfs_server.addrlen,
748                 .nfs_mod = nfs_mod,
749                 .proto = data->nfs_server.protocol,
750                 .net = data->net,
751         };
752         struct rpc_timeout timeparms;
753         struct nfs_client *clp;
754         int error;
755
756         dprintk("--> nfs_init_server()\n");
757
758         nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
759                         data->timeo, data->retrans);
760         if (data->flags & NFS_MOUNT_NORESVPORT)
761                 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
762
763         /* Allocate or find a client reference we can use */
764         clp = nfs_get_client(&cl_init, &timeparms, NULL, RPC_AUTH_UNIX);
765         if (IS_ERR(clp)) {
766                 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
767                 return PTR_ERR(clp);
768         }
769
770         server->nfs_client = clp;
771
772         /* Initialise the client representation from the mount data */
773         server->flags = data->flags;
774         server->options = data->options;
775         server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
776                 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
777                 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME|NFS_CAP_CHANGE_ATTR;
778
779         if (data->rsize)
780                 server->rsize = nfs_block_size(data->rsize, NULL);
781         if (data->wsize)
782                 server->wsize = nfs_block_size(data->wsize, NULL);
783
784         server->acregmin = data->acregmin * HZ;
785         server->acregmax = data->acregmax * HZ;
786         server->acdirmin = data->acdirmin * HZ;
787         server->acdirmax = data->acdirmax * HZ;
788
789         /* Start lockd here, before we might error out */
790         error = nfs_start_lockd(server);
791         if (error < 0)
792                 goto error;
793
794         server->port = data->nfs_server.port;
795         server->auth_info = data->auth_info;
796
797         error = nfs_init_server_rpcclient(server, &timeparms,
798                                           data->selected_flavor);
799         if (error < 0)
800                 goto error;
801
802         /* Preserve the values of mount_server-related mount options */
803         if (data->mount_server.addrlen) {
804                 memcpy(&server->mountd_address, &data->mount_server.address,
805                         data->mount_server.addrlen);
806                 server->mountd_addrlen = data->mount_server.addrlen;
807         }
808         server->mountd_version = data->mount_server.version;
809         server->mountd_port = data->mount_server.port;
810         server->mountd_protocol = data->mount_server.protocol;
811
812         server->namelen  = data->namlen;
813         dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
814         return 0;
815
816 error:
817         server->nfs_client = NULL;
818         nfs_put_client(clp);
819         dprintk("<-- nfs_init_server() = xerror %d\n", error);
820         return error;
821 }
822
823 /*
824  * Load up the server record from information gained in an fsinfo record
825  */
826 static void nfs_server_set_fsinfo(struct nfs_server *server,
827                                   struct nfs_fh *mntfh,
828                                   struct nfs_fsinfo *fsinfo)
829 {
830         unsigned long max_rpc_payload;
831
832         /* Work out a lot of parameters */
833         if (server->rsize == 0)
834                 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
835         if (server->wsize == 0)
836                 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
837
838         if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
839                 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
840         if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
841                 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
842
843         max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
844         if (server->rsize > max_rpc_payload)
845                 server->rsize = max_rpc_payload;
846         if (server->rsize > NFS_MAX_FILE_IO_SIZE)
847                 server->rsize = NFS_MAX_FILE_IO_SIZE;
848         server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
849
850         server->backing_dev_info.name = "nfs";
851         server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
852
853         if (server->wsize > max_rpc_payload)
854                 server->wsize = max_rpc_payload;
855         if (server->wsize > NFS_MAX_FILE_IO_SIZE)
856                 server->wsize = NFS_MAX_FILE_IO_SIZE;
857         server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
858
859         server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
860
861         server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
862         if (server->dtsize > PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES)
863                 server->dtsize = PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES;
864         if (server->dtsize > server->rsize)
865                 server->dtsize = server->rsize;
866
867         if (server->flags & NFS_MOUNT_NOAC) {
868                 server->acregmin = server->acregmax = 0;
869                 server->acdirmin = server->acdirmax = 0;
870         }
871
872         server->maxfilesize = fsinfo->maxfilesize;
873
874         server->time_delta = fsinfo->time_delta;
875
876         /* We're airborne Set socket buffersize */
877         rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
878 }
879
880 /*
881  * Probe filesystem information, including the FSID on v2/v3
882  */
883 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
884 {
885         struct nfs_fsinfo fsinfo;
886         struct nfs_client *clp = server->nfs_client;
887         int error;
888
889         dprintk("--> nfs_probe_fsinfo()\n");
890
891         if (clp->rpc_ops->set_capabilities != NULL) {
892                 error = clp->rpc_ops->set_capabilities(server, mntfh);
893                 if (error < 0)
894                         goto out_error;
895         }
896
897         fsinfo.fattr = fattr;
898         fsinfo.layouttype = 0;
899         error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
900         if (error < 0)
901                 goto out_error;
902
903         nfs_server_set_fsinfo(server, mntfh, &fsinfo);
904
905         /* Get some general file system info */
906         if (server->namelen == 0) {
907                 struct nfs_pathconf pathinfo;
908
909                 pathinfo.fattr = fattr;
910                 nfs_fattr_init(fattr);
911
912                 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
913                         server->namelen = pathinfo.max_namelen;
914         }
915
916         dprintk("<-- nfs_probe_fsinfo() = 0\n");
917         return 0;
918
919 out_error:
920         dprintk("nfs_probe_fsinfo: error = %d\n", -error);
921         return error;
922 }
923 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
924
925 /*
926  * Copy useful information when duplicating a server record
927  */
928 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
929 {
930         target->flags = source->flags;
931         target->rsize = source->rsize;
932         target->wsize = source->wsize;
933         target->acregmin = source->acregmin;
934         target->acregmax = source->acregmax;
935         target->acdirmin = source->acdirmin;
936         target->acdirmax = source->acdirmax;
937         target->caps = source->caps;
938         target->options = source->options;
939         target->auth_info = source->auth_info;
940 }
941 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
942
943 void nfs_server_insert_lists(struct nfs_server *server)
944 {
945         struct nfs_client *clp = server->nfs_client;
946         struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
947
948         spin_lock(&nn->nfs_client_lock);
949         list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
950         list_add_tail(&server->master_link, &nn->nfs_volume_list);
951         clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
952         spin_unlock(&nn->nfs_client_lock);
953
954 }
955 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
956
957 void nfs_server_remove_lists(struct nfs_server *server)
958 {
959         struct nfs_client *clp = server->nfs_client;
960         struct nfs_net *nn;
961
962         if (clp == NULL)
963                 return;
964         nn = net_generic(clp->cl_net, nfs_net_id);
965         spin_lock(&nn->nfs_client_lock);
966         list_del_rcu(&server->client_link);
967         if (list_empty(&clp->cl_superblocks))
968                 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
969         list_del(&server->master_link);
970         spin_unlock(&nn->nfs_client_lock);
971
972         synchronize_rcu();
973 }
974 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
975
976 /*
977  * Allocate and initialise a server record
978  */
979 struct nfs_server *nfs_alloc_server(void)
980 {
981         struct nfs_server *server;
982
983         server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
984         if (!server)
985                 return NULL;
986
987         server->client = server->client_acl = ERR_PTR(-EINVAL);
988
989         /* Zero out the NFS state stuff */
990         INIT_LIST_HEAD(&server->client_link);
991         INIT_LIST_HEAD(&server->master_link);
992         INIT_LIST_HEAD(&server->delegations);
993         INIT_LIST_HEAD(&server->layouts);
994         INIT_LIST_HEAD(&server->state_owners_lru);
995
996         atomic_set(&server->active, 0);
997
998         server->io_stats = nfs_alloc_iostats();
999         if (!server->io_stats) {
1000                 kfree(server);
1001                 return NULL;
1002         }
1003
1004         if (bdi_init(&server->backing_dev_info)) {
1005                 nfs_free_iostats(server->io_stats);
1006                 kfree(server);
1007                 return NULL;
1008         }
1009
1010         ida_init(&server->openowner_id);
1011         ida_init(&server->lockowner_id);
1012         pnfs_init_server(server);
1013
1014         return server;
1015 }
1016 EXPORT_SYMBOL_GPL(nfs_alloc_server);
1017
1018 /*
1019  * Free up a server record
1020  */
1021 void nfs_free_server(struct nfs_server *server)
1022 {
1023         dprintk("--> nfs_free_server()\n");
1024
1025         nfs_server_remove_lists(server);
1026
1027         if (server->destroy != NULL)
1028                 server->destroy(server);
1029
1030         if (!IS_ERR(server->client_acl))
1031                 rpc_shutdown_client(server->client_acl);
1032         if (!IS_ERR(server->client))
1033                 rpc_shutdown_client(server->client);
1034
1035         nfs_put_client(server->nfs_client);
1036
1037         ida_destroy(&server->lockowner_id);
1038         ida_destroy(&server->openowner_id);
1039         nfs_free_iostats(server->io_stats);
1040         bdi_destroy(&server->backing_dev_info);
1041         kfree(server);
1042         nfs_release_automount_timer();
1043         dprintk("<-- nfs_free_server()\n");
1044 }
1045 EXPORT_SYMBOL_GPL(nfs_free_server);
1046
1047 /*
1048  * Create a version 2 or 3 volume record
1049  * - keyed on server and FSID
1050  */
1051 struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
1052                                      struct nfs_subversion *nfs_mod)
1053 {
1054         struct nfs_server *server;
1055         struct nfs_fattr *fattr;
1056         int error;
1057
1058         server = nfs_alloc_server();
1059         if (!server)
1060                 return ERR_PTR(-ENOMEM);
1061
1062         error = -ENOMEM;
1063         fattr = nfs_alloc_fattr();
1064         if (fattr == NULL)
1065                 goto error;
1066
1067         /* Get a client representation */
1068         error = nfs_init_server(server, mount_info->parsed, nfs_mod);
1069         if (error < 0)
1070                 goto error;
1071
1072         /* Probe the root fh to retrieve its FSID */
1073         error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
1074         if (error < 0)
1075                 goto error;
1076         if (server->nfs_client->rpc_ops->version == 3) {
1077                 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1078                         server->namelen = NFS3_MAXNAMLEN;
1079                 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
1080                         server->caps |= NFS_CAP_READDIRPLUS;
1081         } else {
1082                 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1083                         server->namelen = NFS2_MAXNAMLEN;
1084         }
1085
1086         if (!(fattr->valid & NFS_ATTR_FATTR)) {
1087                 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr, NULL);
1088                 if (error < 0) {
1089                         dprintk("nfs_create_server: getattr error = %d\n", -error);
1090                         goto error;
1091                 }
1092         }
1093         memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1094
1095         dprintk("Server FSID: %llx:%llx\n",
1096                 (unsigned long long) server->fsid.major,
1097                 (unsigned long long) server->fsid.minor);
1098
1099         nfs_server_insert_lists(server);
1100         server->mount_time = jiffies;
1101         nfs_free_fattr(fattr);
1102         return server;
1103
1104 error:
1105         nfs_free_fattr(fattr);
1106         nfs_free_server(server);
1107         return ERR_PTR(error);
1108 }
1109 EXPORT_SYMBOL_GPL(nfs_create_server);
1110
1111 /*
1112  * Clone an NFS2, NFS3 or NFS4 server record
1113  */
1114 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1115                                     struct nfs_fh *fh,
1116                                     struct nfs_fattr *fattr,
1117                                     rpc_authflavor_t flavor)
1118 {
1119         struct nfs_server *server;
1120         struct nfs_fattr *fattr_fsinfo;
1121         int error;
1122
1123         dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1124                 (unsigned long long) fattr->fsid.major,
1125                 (unsigned long long) fattr->fsid.minor);
1126
1127         server = nfs_alloc_server();
1128         if (!server)
1129                 return ERR_PTR(-ENOMEM);
1130
1131         error = -ENOMEM;
1132         fattr_fsinfo = nfs_alloc_fattr();
1133         if (fattr_fsinfo == NULL)
1134                 goto out_free_server;
1135
1136         /* Copy data from the source */
1137         server->nfs_client = source->nfs_client;
1138         server->destroy = source->destroy;
1139         atomic_inc(&server->nfs_client->cl_count);
1140         nfs_server_copy_userdata(server, source);
1141
1142         server->fsid = fattr->fsid;
1143
1144         error = nfs_init_server_rpcclient(server,
1145                         source->client->cl_timeout,
1146                         flavor);
1147         if (error < 0)
1148                 goto out_free_server;
1149
1150         /* probe the filesystem info for this server filesystem */
1151         error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1152         if (error < 0)
1153                 goto out_free_server;
1154
1155         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1156                 server->namelen = NFS4_MAXNAMLEN;
1157
1158         dprintk("Cloned FSID: %llx:%llx\n",
1159                 (unsigned long long) server->fsid.major,
1160                 (unsigned long long) server->fsid.minor);
1161
1162         error = nfs_start_lockd(server);
1163         if (error < 0)
1164                 goto out_free_server;
1165
1166         nfs_server_insert_lists(server);
1167         server->mount_time = jiffies;
1168
1169         nfs_free_fattr(fattr_fsinfo);
1170         dprintk("<-- nfs_clone_server() = %p\n", server);
1171         return server;
1172
1173 out_free_server:
1174         nfs_free_fattr(fattr_fsinfo);
1175         nfs_free_server(server);
1176         dprintk("<-- nfs_clone_server() = error %d\n", error);
1177         return ERR_PTR(error);
1178 }
1179 EXPORT_SYMBOL_GPL(nfs_clone_server);
1180
1181 void nfs_clients_init(struct net *net)
1182 {
1183         struct nfs_net *nn = net_generic(net, nfs_net_id);
1184
1185         INIT_LIST_HEAD(&nn->nfs_client_list);
1186         INIT_LIST_HEAD(&nn->nfs_volume_list);
1187 #if IS_ENABLED(CONFIG_NFS_V4)
1188         idr_init(&nn->cb_ident_idr);
1189 #endif
1190         spin_lock_init(&nn->nfs_client_lock);
1191         nn->boot_time = CURRENT_TIME;
1192 }
1193
1194 #ifdef CONFIG_PROC_FS
1195 static struct proc_dir_entry *proc_fs_nfs;
1196
1197 static int nfs_server_list_open(struct inode *inode, struct file *file);
1198 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1199 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1200 static void nfs_server_list_stop(struct seq_file *p, void *v);
1201 static int nfs_server_list_show(struct seq_file *m, void *v);
1202
1203 static const struct seq_operations nfs_server_list_ops = {
1204         .start  = nfs_server_list_start,
1205         .next   = nfs_server_list_next,
1206         .stop   = nfs_server_list_stop,
1207         .show   = nfs_server_list_show,
1208 };
1209
1210 static const struct file_operations nfs_server_list_fops = {
1211         .open           = nfs_server_list_open,
1212         .read           = seq_read,
1213         .llseek         = seq_lseek,
1214         .release        = seq_release,
1215         .owner          = THIS_MODULE,
1216 };
1217
1218 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1219 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1220 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1221 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1222 static int nfs_volume_list_show(struct seq_file *m, void *v);
1223
1224 static const struct seq_operations nfs_volume_list_ops = {
1225         .start  = nfs_volume_list_start,
1226         .next   = nfs_volume_list_next,
1227         .stop   = nfs_volume_list_stop,
1228         .show   = nfs_volume_list_show,
1229 };
1230
1231 static const struct file_operations nfs_volume_list_fops = {
1232         .open           = nfs_volume_list_open,
1233         .read           = seq_read,
1234         .llseek         = seq_lseek,
1235         .release        = seq_release,
1236         .owner          = THIS_MODULE,
1237 };
1238
1239 /*
1240  * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1241  * we're dealing
1242  */
1243 static int nfs_server_list_open(struct inode *inode, struct file *file)
1244 {
1245         struct seq_file *m;
1246         int ret;
1247         struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1248         struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1249
1250         ret = seq_open(file, &nfs_server_list_ops);
1251         if (ret < 0)
1252                 return ret;
1253
1254         m = file->private_data;
1255         m->private = net;
1256
1257         return 0;
1258 }
1259
1260 /*
1261  * set up the iterator to start reading from the server list and return the first item
1262  */
1263 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1264 {
1265         struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1266
1267         /* lock the list against modification */
1268         spin_lock(&nn->nfs_client_lock);
1269         return seq_list_start_head(&nn->nfs_client_list, *_pos);
1270 }
1271
1272 /*
1273  * move to next server
1274  */
1275 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1276 {
1277         struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1278
1279         return seq_list_next(v, &nn->nfs_client_list, pos);
1280 }
1281
1282 /*
1283  * clean up after reading from the transports list
1284  */
1285 static void nfs_server_list_stop(struct seq_file *p, void *v)
1286 {
1287         struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1288
1289         spin_unlock(&nn->nfs_client_lock);
1290 }
1291
1292 /*
1293  * display a header line followed by a load of call lines
1294  */
1295 static int nfs_server_list_show(struct seq_file *m, void *v)
1296 {
1297         struct nfs_client *clp;
1298         struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1299
1300         /* display header on line 1 */
1301         if (v == &nn->nfs_client_list) {
1302                 seq_puts(m, "NV SERVER   PORT USE HOSTNAME\n");
1303                 return 0;
1304         }
1305
1306         /* display one transport per line on subsequent lines */
1307         clp = list_entry(v, struct nfs_client, cl_share_link);
1308
1309         /* Check if the client is initialized */
1310         if (clp->cl_cons_state != NFS_CS_READY)
1311                 return 0;
1312
1313         rcu_read_lock();
1314         seq_printf(m, "v%u %s %s %3d %s\n",
1315                    clp->rpc_ops->version,
1316                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1317                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1318                    atomic_read(&clp->cl_count),
1319                    clp->cl_hostname);
1320         rcu_read_unlock();
1321
1322         return 0;
1323 }
1324
1325 /*
1326  * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1327  */
1328 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1329 {
1330         struct seq_file *m;
1331         int ret;
1332         struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1333         struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1334
1335         ret = seq_open(file, &nfs_volume_list_ops);
1336         if (ret < 0)
1337                 return ret;
1338
1339         m = file->private_data;
1340         m->private = net;
1341
1342         return 0;
1343 }
1344
1345 /*
1346  * set up the iterator to start reading from the volume list and return the first item
1347  */
1348 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1349 {
1350         struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1351
1352         /* lock the list against modification */
1353         spin_lock(&nn->nfs_client_lock);
1354         return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1355 }
1356
1357 /*
1358  * move to next volume
1359  */
1360 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1361 {
1362         struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1363
1364         return seq_list_next(v, &nn->nfs_volume_list, pos);
1365 }
1366
1367 /*
1368  * clean up after reading from the transports list
1369  */
1370 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1371 {
1372         struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1373
1374         spin_unlock(&nn->nfs_client_lock);
1375 }
1376
1377 /*
1378  * display a header line followed by a load of call lines
1379  */
1380 static int nfs_volume_list_show(struct seq_file *m, void *v)
1381 {
1382         struct nfs_server *server;
1383         struct nfs_client *clp;
1384         char dev[8], fsid[17];
1385         struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1386
1387         /* display header on line 1 */
1388         if (v == &nn->nfs_volume_list) {
1389                 seq_puts(m, "NV SERVER   PORT DEV     FSID              FSC\n");
1390                 return 0;
1391         }
1392         /* display one transport per line on subsequent lines */
1393         server = list_entry(v, struct nfs_server, master_link);
1394         clp = server->nfs_client;
1395
1396         snprintf(dev, 8, "%u:%u",
1397                  MAJOR(server->s_dev), MINOR(server->s_dev));
1398
1399         snprintf(fsid, 17, "%llx:%llx",
1400                  (unsigned long long) server->fsid.major,
1401                  (unsigned long long) server->fsid.minor);
1402
1403         rcu_read_lock();
1404         seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
1405                    clp->rpc_ops->version,
1406                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1407                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1408                    dev,
1409                    fsid,
1410                    nfs_server_fscache_state(server));
1411         rcu_read_unlock();
1412
1413         return 0;
1414 }
1415
1416 /*
1417  * initialise the /proc/fs/nfsfs/ directory
1418  */
1419 int __init nfs_fs_proc_init(void)
1420 {
1421         struct proc_dir_entry *p;
1422
1423         proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1424         if (!proc_fs_nfs)
1425                 goto error_0;
1426
1427         /* a file of servers with which we're dealing */
1428         p = proc_create("servers", S_IFREG|S_IRUGO,
1429                         proc_fs_nfs, &nfs_server_list_fops);
1430         if (!p)
1431                 goto error_1;
1432
1433         /* a file of volumes that we have mounted */
1434         p = proc_create("volumes", S_IFREG|S_IRUGO,
1435                         proc_fs_nfs, &nfs_volume_list_fops);
1436         if (!p)
1437                 goto error_2;
1438         return 0;
1439
1440 error_2:
1441         remove_proc_entry("servers", proc_fs_nfs);
1442 error_1:
1443         remove_proc_entry("fs/nfsfs", NULL);
1444 error_0:
1445         return -ENOMEM;
1446 }
1447
1448 /*
1449  * clean up the /proc/fs/nfsfs/ directory
1450  */
1451 void nfs_fs_proc_exit(void)
1452 {
1453         remove_proc_entry("volumes", proc_fs_nfs);
1454         remove_proc_entry("servers", proc_fs_nfs);
1455         remove_proc_entry("fs/nfsfs", NULL);
1456 }
1457
1458 #endif /* CONFIG_PROC_FS */