xref: /linux/fs/nfs/client.c (revision 4413e16d9d21673bb5048a2e542f1aaa00015c2e)
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 /* idr_remove_all is not needed as all id's are removed by nfs_put_client */
201 void nfs_cleanup_cb_ident_idr(struct net *net)
202 {
203 	struct nfs_net *nn = net_generic(net, nfs_net_id);
204 
205 	idr_destroy(&nn->cb_ident_idr);
206 }
207 
208 /* nfs_client_lock held */
209 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
210 {
211 	struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
212 
213 	if (clp->cl_cb_ident)
214 		idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
215 }
216 
217 static void pnfs_init_server(struct nfs_server *server)
218 {
219 	rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
220 }
221 
222 #else
223 void nfs_cleanup_cb_ident_idr(struct net *net)
224 {
225 }
226 
227 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
228 {
229 }
230 
231 static void pnfs_init_server(struct nfs_server *server)
232 {
233 }
234 
235 #endif /* CONFIG_NFS_V4 */
236 
237 /*
238  * Destroy a shared client record
239  */
240 void nfs_free_client(struct nfs_client *clp)
241 {
242 	dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
243 
244 	nfs_fscache_release_client_cookie(clp);
245 
246 	/* -EIO all pending I/O */
247 	if (!IS_ERR(clp->cl_rpcclient))
248 		rpc_shutdown_client(clp->cl_rpcclient);
249 
250 	if (clp->cl_machine_cred != NULL)
251 		put_rpccred(clp->cl_machine_cred);
252 
253 	put_net(clp->cl_net);
254 	put_nfs_version(clp->cl_nfs_mod);
255 	kfree(clp->cl_hostname);
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 		BUG_ON(!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 	dprintk("--> nfs_get_client(%s,v%u)\n",
487 		cl_init->hostname ?: "", rpc_ops->version);
488 
489 	/* see if the client already exists */
490 	do {
491 		spin_lock(&nn->nfs_client_lock);
492 
493 		clp = nfs_match_client(cl_init);
494 		if (clp) {
495 			spin_unlock(&nn->nfs_client_lock);
496 			if (new)
497 				new->rpc_ops->free_client(new);
498 			return nfs_found_client(cl_init, clp);
499 		}
500 		if (new) {
501 			list_add(&new->cl_share_link, &nn->nfs_client_list);
502 			spin_unlock(&nn->nfs_client_lock);
503 			new->cl_flags = cl_init->init_flags;
504 			return rpc_ops->init_client(new, timeparms, ip_addr,
505 						    authflavour);
506 		}
507 
508 		spin_unlock(&nn->nfs_client_lock);
509 
510 		new = rpc_ops->alloc_client(cl_init);
511 	} while (!IS_ERR(new));
512 
513 	dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
514 		cl_init->hostname ?: "", PTR_ERR(new));
515 	return new;
516 }
517 EXPORT_SYMBOL_GPL(nfs_get_client);
518 
519 /*
520  * Mark a server as ready or failed
521  */
522 void nfs_mark_client_ready(struct nfs_client *clp, int state)
523 {
524 	smp_wmb();
525 	clp->cl_cons_state = state;
526 	wake_up_all(&nfs_client_active_wq);
527 }
528 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
529 
530 /*
531  * Initialise the timeout values for a connection
532  */
533 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
534 				    unsigned int timeo, unsigned int retrans)
535 {
536 	to->to_initval = timeo * HZ / 10;
537 	to->to_retries = retrans;
538 
539 	switch (proto) {
540 	case XPRT_TRANSPORT_TCP:
541 	case XPRT_TRANSPORT_RDMA:
542 		if (to->to_retries == 0)
543 			to->to_retries = NFS_DEF_TCP_RETRANS;
544 		if (to->to_initval == 0)
545 			to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
546 		if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
547 			to->to_initval = NFS_MAX_TCP_TIMEOUT;
548 		to->to_increment = to->to_initval;
549 		to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
550 		if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
551 			to->to_maxval = NFS_MAX_TCP_TIMEOUT;
552 		if (to->to_maxval < to->to_initval)
553 			to->to_maxval = to->to_initval;
554 		to->to_exponential = 0;
555 		break;
556 	case XPRT_TRANSPORT_UDP:
557 		if (to->to_retries == 0)
558 			to->to_retries = NFS_DEF_UDP_RETRANS;
559 		if (!to->to_initval)
560 			to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
561 		if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
562 			to->to_initval = NFS_MAX_UDP_TIMEOUT;
563 		to->to_maxval = NFS_MAX_UDP_TIMEOUT;
564 		to->to_exponential = 1;
565 		break;
566 	default:
567 		BUG();
568 	}
569 }
570 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
571 
572 /*
573  * Create an RPC client handle
574  */
575 int nfs_create_rpc_client(struct nfs_client *clp,
576 			  const struct rpc_timeout *timeparms,
577 			  rpc_authflavor_t flavor)
578 {
579 	struct rpc_clnt		*clnt = NULL;
580 	struct rpc_create_args args = {
581 		.net		= clp->cl_net,
582 		.protocol	= clp->cl_proto,
583 		.address	= (struct sockaddr *)&clp->cl_addr,
584 		.addrsize	= clp->cl_addrlen,
585 		.timeout	= timeparms,
586 		.servername	= clp->cl_hostname,
587 		.program	= &nfs_program,
588 		.version	= clp->rpc_ops->version,
589 		.authflavor	= flavor,
590 	};
591 
592 	if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
593 		args.flags |= RPC_CLNT_CREATE_DISCRTRY;
594 	if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
595 		args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
596 
597 	if (!IS_ERR(clp->cl_rpcclient))
598 		return 0;
599 
600 	clnt = rpc_create(&args);
601 	if (IS_ERR(clnt)) {
602 		dprintk("%s: cannot create RPC client. Error = %ld\n",
603 				__func__, PTR_ERR(clnt));
604 		return PTR_ERR(clnt);
605 	}
606 
607 	clp->cl_rpcclient = clnt;
608 	return 0;
609 }
610 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
611 
612 /*
613  * Version 2 or 3 client destruction
614  */
615 static void nfs_destroy_server(struct nfs_server *server)
616 {
617 	if (!(server->flags & NFS_MOUNT_LOCAL_FLOCK) ||
618 			!(server->flags & NFS_MOUNT_LOCAL_FCNTL))
619 		nlmclnt_done(server->nlm_host);
620 }
621 
622 /*
623  * Version 2 or 3 lockd setup
624  */
625 static int nfs_start_lockd(struct nfs_server *server)
626 {
627 	struct nlm_host *host;
628 	struct nfs_client *clp = server->nfs_client;
629 	struct nlmclnt_initdata nlm_init = {
630 		.hostname	= clp->cl_hostname,
631 		.address	= (struct sockaddr *)&clp->cl_addr,
632 		.addrlen	= clp->cl_addrlen,
633 		.nfs_version	= clp->rpc_ops->version,
634 		.noresvport	= server->flags & NFS_MOUNT_NORESVPORT ?
635 					1 : 0,
636 		.net		= clp->cl_net,
637 	};
638 
639 	if (nlm_init.nfs_version > 3)
640 		return 0;
641 	if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
642 			(server->flags & NFS_MOUNT_LOCAL_FCNTL))
643 		return 0;
644 
645 	switch (clp->cl_proto) {
646 		default:
647 			nlm_init.protocol = IPPROTO_TCP;
648 			break;
649 		case XPRT_TRANSPORT_UDP:
650 			nlm_init.protocol = IPPROTO_UDP;
651 	}
652 
653 	host = nlmclnt_init(&nlm_init);
654 	if (IS_ERR(host))
655 		return PTR_ERR(host);
656 
657 	server->nlm_host = host;
658 	server->destroy = nfs_destroy_server;
659 	return 0;
660 }
661 
662 /*
663  * Create a general RPC client
664  */
665 int nfs_init_server_rpcclient(struct nfs_server *server,
666 		const struct rpc_timeout *timeo,
667 		rpc_authflavor_t pseudoflavour)
668 {
669 	struct nfs_client *clp = server->nfs_client;
670 
671 	server->client = rpc_clone_client(clp->cl_rpcclient);
672 	if (IS_ERR(server->client)) {
673 		dprintk("%s: couldn't create rpc_client!\n", __func__);
674 		return PTR_ERR(server->client);
675 	}
676 
677 	memcpy(&server->client->cl_timeout_default,
678 			timeo,
679 			sizeof(server->client->cl_timeout_default));
680 	server->client->cl_timeout = &server->client->cl_timeout_default;
681 
682 	if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
683 		struct rpc_auth *auth;
684 
685 		auth = rpcauth_create(pseudoflavour, server->client);
686 		if (IS_ERR(auth)) {
687 			dprintk("%s: couldn't create credcache!\n", __func__);
688 			return PTR_ERR(auth);
689 		}
690 	}
691 	server->client->cl_softrtry = 0;
692 	if (server->flags & NFS_MOUNT_SOFT)
693 		server->client->cl_softrtry = 1;
694 
695 	return 0;
696 }
697 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
698 
699 /**
700  * nfs_init_client - Initialise an NFS2 or NFS3 client
701  *
702  * @clp: nfs_client to initialise
703  * @timeparms: timeout parameters for underlying RPC transport
704  * @ip_addr: IP presentation address (not used)
705  * @authflavor: authentication flavor for underlying RPC transport
706  *
707  * Returns pointer to an NFS client, or an ERR_PTR value.
708  */
709 struct nfs_client *nfs_init_client(struct nfs_client *clp,
710 		    const struct rpc_timeout *timeparms,
711 		    const char *ip_addr, rpc_authflavor_t authflavour)
712 {
713 	int error;
714 
715 	if (clp->cl_cons_state == NFS_CS_READY) {
716 		/* the client is already initialised */
717 		dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
718 		return clp;
719 	}
720 
721 	/*
722 	 * Create a client RPC handle for doing FSSTAT with UNIX auth only
723 	 * - RFC 2623, sec 2.3.2
724 	 */
725 	error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX);
726 	if (error < 0)
727 		goto error;
728 	nfs_mark_client_ready(clp, NFS_CS_READY);
729 	return clp;
730 
731 error:
732 	nfs_mark_client_ready(clp, error);
733 	nfs_put_client(clp);
734 	dprintk("<-- nfs_init_client() = xerror %d\n", error);
735 	return ERR_PTR(error);
736 }
737 EXPORT_SYMBOL_GPL(nfs_init_client);
738 
739 /*
740  * Create a version 2 or 3 client
741  */
742 static int nfs_init_server(struct nfs_server *server,
743 			   const struct nfs_parsed_mount_data *data,
744 			   struct nfs_subversion *nfs_mod)
745 {
746 	struct nfs_client_initdata cl_init = {
747 		.hostname = data->nfs_server.hostname,
748 		.addr = (const struct sockaddr *)&data->nfs_server.address,
749 		.addrlen = data->nfs_server.addrlen,
750 		.nfs_mod = nfs_mod,
751 		.proto = data->nfs_server.protocol,
752 		.net = data->net,
753 	};
754 	struct rpc_timeout timeparms;
755 	struct nfs_client *clp;
756 	int error;
757 
758 	dprintk("--> nfs_init_server()\n");
759 
760 	nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
761 			data->timeo, data->retrans);
762 	if (data->flags & NFS_MOUNT_NORESVPORT)
763 		set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
764 
765 	/* Allocate or find a client reference we can use */
766 	clp = nfs_get_client(&cl_init, &timeparms, NULL, RPC_AUTH_UNIX);
767 	if (IS_ERR(clp)) {
768 		dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
769 		return PTR_ERR(clp);
770 	}
771 
772 	server->nfs_client = clp;
773 
774 	/* Initialise the client representation from the mount data */
775 	server->flags = data->flags;
776 	server->options = data->options;
777 	server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
778 		NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
779 		NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME|NFS_CAP_CHANGE_ATTR;
780 
781 	if (data->rsize)
782 		server->rsize = nfs_block_size(data->rsize, NULL);
783 	if (data->wsize)
784 		server->wsize = nfs_block_size(data->wsize, NULL);
785 
786 	server->acregmin = data->acregmin * HZ;
787 	server->acregmax = data->acregmax * HZ;
788 	server->acdirmin = data->acdirmin * HZ;
789 	server->acdirmax = data->acdirmax * HZ;
790 
791 	/* Start lockd here, before we might error out */
792 	error = nfs_start_lockd(server);
793 	if (error < 0)
794 		goto error;
795 
796 	server->port = data->nfs_server.port;
797 
798 	error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
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 	server->pnfs_blksize = fsinfo->blksize;
859 
860 	server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
861 
862 	server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
863 	if (server->dtsize > PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES)
864 		server->dtsize = PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES;
865 	if (server->dtsize > server->rsize)
866 		server->dtsize = server->rsize;
867 
868 	if (server->flags & NFS_MOUNT_NOAC) {
869 		server->acregmin = server->acregmax = 0;
870 		server->acdirmin = server->acdirmax = 0;
871 	}
872 
873 	server->maxfilesize = fsinfo->maxfilesize;
874 
875 	server->time_delta = fsinfo->time_delta;
876 
877 	/* We're airborne Set socket buffersize */
878 	rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
879 }
880 
881 /*
882  * Probe filesystem information, including the FSID on v2/v3
883  */
884 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
885 {
886 	struct nfs_fsinfo fsinfo;
887 	struct nfs_client *clp = server->nfs_client;
888 	int error;
889 
890 	dprintk("--> nfs_probe_fsinfo()\n");
891 
892 	if (clp->rpc_ops->set_capabilities != NULL) {
893 		error = clp->rpc_ops->set_capabilities(server, mntfh);
894 		if (error < 0)
895 			goto out_error;
896 	}
897 
898 	fsinfo.fattr = fattr;
899 	fsinfo.layouttype = 0;
900 	error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
901 	if (error < 0)
902 		goto out_error;
903 
904 	nfs_server_set_fsinfo(server, mntfh, &fsinfo);
905 
906 	/* Get some general file system info */
907 	if (server->namelen == 0) {
908 		struct nfs_pathconf pathinfo;
909 
910 		pathinfo.fattr = fattr;
911 		nfs_fattr_init(fattr);
912 
913 		if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
914 			server->namelen = pathinfo.max_namelen;
915 	}
916 
917 	dprintk("<-- nfs_probe_fsinfo() = 0\n");
918 	return 0;
919 
920 out_error:
921 	dprintk("nfs_probe_fsinfo: error = %d\n", -error);
922 	return error;
923 }
924 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
925 
926 /*
927  * Copy useful information when duplicating a server record
928  */
929 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
930 {
931 	target->flags = source->flags;
932 	target->rsize = source->rsize;
933 	target->wsize = source->wsize;
934 	target->acregmin = source->acregmin;
935 	target->acregmax = source->acregmax;
936 	target->acdirmin = source->acdirmin;
937 	target->acdirmax = source->acdirmax;
938 	target->caps = source->caps;
939 	target->options = source->options;
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 static 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 
975 /*
976  * Allocate and initialise a server record
977  */
978 struct nfs_server *nfs_alloc_server(void)
979 {
980 	struct nfs_server *server;
981 
982 	server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
983 	if (!server)
984 		return NULL;
985 
986 	server->client = server->client_acl = ERR_PTR(-EINVAL);
987 
988 	/* Zero out the NFS state stuff */
989 	INIT_LIST_HEAD(&server->client_link);
990 	INIT_LIST_HEAD(&server->master_link);
991 	INIT_LIST_HEAD(&server->delegations);
992 	INIT_LIST_HEAD(&server->layouts);
993 	INIT_LIST_HEAD(&server->state_owners_lru);
994 
995 	atomic_set(&server->active, 0);
996 
997 	server->io_stats = nfs_alloc_iostats();
998 	if (!server->io_stats) {
999 		kfree(server);
1000 		return NULL;
1001 	}
1002 
1003 	if (bdi_init(&server->backing_dev_info)) {
1004 		nfs_free_iostats(server->io_stats);
1005 		kfree(server);
1006 		return NULL;
1007 	}
1008 
1009 	ida_init(&server->openowner_id);
1010 	ida_init(&server->lockowner_id);
1011 	pnfs_init_server(server);
1012 
1013 	return server;
1014 }
1015 EXPORT_SYMBOL_GPL(nfs_alloc_server);
1016 
1017 /*
1018  * Free up a server record
1019  */
1020 void nfs_free_server(struct nfs_server *server)
1021 {
1022 	dprintk("--> nfs_free_server()\n");
1023 
1024 	nfs_server_remove_lists(server);
1025 
1026 	if (server->destroy != NULL)
1027 		server->destroy(server);
1028 
1029 	if (!IS_ERR(server->client_acl))
1030 		rpc_shutdown_client(server->client_acl);
1031 	if (!IS_ERR(server->client))
1032 		rpc_shutdown_client(server->client);
1033 
1034 	nfs_put_client(server->nfs_client);
1035 
1036 	ida_destroy(&server->lockowner_id);
1037 	ida_destroy(&server->openowner_id);
1038 	nfs_free_iostats(server->io_stats);
1039 	bdi_destroy(&server->backing_dev_info);
1040 	kfree(server);
1041 	nfs_release_automount_timer();
1042 	dprintk("<-- nfs_free_server()\n");
1043 }
1044 EXPORT_SYMBOL_GPL(nfs_free_server);
1045 
1046 /*
1047  * Create a version 2 or 3 volume record
1048  * - keyed on server and FSID
1049  */
1050 struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
1051 				     struct nfs_subversion *nfs_mod)
1052 {
1053 	struct nfs_server *server;
1054 	struct nfs_fattr *fattr;
1055 	int error;
1056 
1057 	server = nfs_alloc_server();
1058 	if (!server)
1059 		return ERR_PTR(-ENOMEM);
1060 
1061 	error = -ENOMEM;
1062 	fattr = nfs_alloc_fattr();
1063 	if (fattr == NULL)
1064 		goto error;
1065 
1066 	/* Get a client representation */
1067 	error = nfs_init_server(server, mount_info->parsed, nfs_mod);
1068 	if (error < 0)
1069 		goto error;
1070 
1071 	BUG_ON(!server->nfs_client);
1072 	BUG_ON(!server->nfs_client->rpc_ops);
1073 	BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1074 
1075 	/* Probe the root fh to retrieve its FSID */
1076 	error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
1077 	if (error < 0)
1078 		goto error;
1079 	if (server->nfs_client->rpc_ops->version == 3) {
1080 		if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1081 			server->namelen = NFS3_MAXNAMLEN;
1082 		if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
1083 			server->caps |= NFS_CAP_READDIRPLUS;
1084 	} else {
1085 		if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1086 			server->namelen = NFS2_MAXNAMLEN;
1087 	}
1088 
1089 	if (!(fattr->valid & NFS_ATTR_FATTR)) {
1090 		error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr);
1091 		if (error < 0) {
1092 			dprintk("nfs_create_server: getattr error = %d\n", -error);
1093 			goto error;
1094 		}
1095 	}
1096 	memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1097 
1098 	dprintk("Server FSID: %llx:%llx\n",
1099 		(unsigned long long) server->fsid.major,
1100 		(unsigned long long) server->fsid.minor);
1101 
1102 	nfs_server_insert_lists(server);
1103 	server->mount_time = jiffies;
1104 	nfs_free_fattr(fattr);
1105 	return server;
1106 
1107 error:
1108 	nfs_free_fattr(fattr);
1109 	nfs_free_server(server);
1110 	return ERR_PTR(error);
1111 }
1112 EXPORT_SYMBOL_GPL(nfs_create_server);
1113 
1114 /*
1115  * Clone an NFS2, NFS3 or NFS4 server record
1116  */
1117 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1118 				    struct nfs_fh *fh,
1119 				    struct nfs_fattr *fattr,
1120 				    rpc_authflavor_t flavor)
1121 {
1122 	struct nfs_server *server;
1123 	struct nfs_fattr *fattr_fsinfo;
1124 	int error;
1125 
1126 	dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1127 		(unsigned long long) fattr->fsid.major,
1128 		(unsigned long long) fattr->fsid.minor);
1129 
1130 	server = nfs_alloc_server();
1131 	if (!server)
1132 		return ERR_PTR(-ENOMEM);
1133 
1134 	error = -ENOMEM;
1135 	fattr_fsinfo = nfs_alloc_fattr();
1136 	if (fattr_fsinfo == NULL)
1137 		goto out_free_server;
1138 
1139 	/* Copy data from the source */
1140 	server->nfs_client = source->nfs_client;
1141 	server->destroy = source->destroy;
1142 	atomic_inc(&server->nfs_client->cl_count);
1143 	nfs_server_copy_userdata(server, source);
1144 
1145 	server->fsid = fattr->fsid;
1146 
1147 	error = nfs_init_server_rpcclient(server,
1148 			source->client->cl_timeout,
1149 			flavor);
1150 	if (error < 0)
1151 		goto out_free_server;
1152 
1153 	/* probe the filesystem info for this server filesystem */
1154 	error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1155 	if (error < 0)
1156 		goto out_free_server;
1157 
1158 	if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1159 		server->namelen = NFS4_MAXNAMLEN;
1160 
1161 	dprintk("Cloned FSID: %llx:%llx\n",
1162 		(unsigned long long) server->fsid.major,
1163 		(unsigned long long) server->fsid.minor);
1164 
1165 	error = nfs_start_lockd(server);
1166 	if (error < 0)
1167 		goto out_free_server;
1168 
1169 	nfs_server_insert_lists(server);
1170 	server->mount_time = jiffies;
1171 
1172 	nfs_free_fattr(fattr_fsinfo);
1173 	dprintk("<-- nfs_clone_server() = %p\n", server);
1174 	return server;
1175 
1176 out_free_server:
1177 	nfs_free_fattr(fattr_fsinfo);
1178 	nfs_free_server(server);
1179 	dprintk("<-- nfs_clone_server() = error %d\n", error);
1180 	return ERR_PTR(error);
1181 }
1182 EXPORT_SYMBOL_GPL(nfs_clone_server);
1183 
1184 void nfs_clients_init(struct net *net)
1185 {
1186 	struct nfs_net *nn = net_generic(net, nfs_net_id);
1187 
1188 	INIT_LIST_HEAD(&nn->nfs_client_list);
1189 	INIT_LIST_HEAD(&nn->nfs_volume_list);
1190 #if IS_ENABLED(CONFIG_NFS_V4)
1191 	idr_init(&nn->cb_ident_idr);
1192 #endif
1193 	spin_lock_init(&nn->nfs_client_lock);
1194 	nn->boot_time = CURRENT_TIME;
1195 }
1196 
1197 #ifdef CONFIG_PROC_FS
1198 static struct proc_dir_entry *proc_fs_nfs;
1199 
1200 static int nfs_server_list_open(struct inode *inode, struct file *file);
1201 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1202 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1203 static void nfs_server_list_stop(struct seq_file *p, void *v);
1204 static int nfs_server_list_show(struct seq_file *m, void *v);
1205 
1206 static const struct seq_operations nfs_server_list_ops = {
1207 	.start	= nfs_server_list_start,
1208 	.next	= nfs_server_list_next,
1209 	.stop	= nfs_server_list_stop,
1210 	.show	= nfs_server_list_show,
1211 };
1212 
1213 static const struct file_operations nfs_server_list_fops = {
1214 	.open		= nfs_server_list_open,
1215 	.read		= seq_read,
1216 	.llseek		= seq_lseek,
1217 	.release	= seq_release,
1218 	.owner		= THIS_MODULE,
1219 };
1220 
1221 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1222 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1223 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1224 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1225 static int nfs_volume_list_show(struct seq_file *m, void *v);
1226 
1227 static const struct seq_operations nfs_volume_list_ops = {
1228 	.start	= nfs_volume_list_start,
1229 	.next	= nfs_volume_list_next,
1230 	.stop	= nfs_volume_list_stop,
1231 	.show	= nfs_volume_list_show,
1232 };
1233 
1234 static const struct file_operations nfs_volume_list_fops = {
1235 	.open		= nfs_volume_list_open,
1236 	.read		= seq_read,
1237 	.llseek		= seq_lseek,
1238 	.release	= seq_release,
1239 	.owner		= THIS_MODULE,
1240 };
1241 
1242 /*
1243  * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1244  * we're dealing
1245  */
1246 static int nfs_server_list_open(struct inode *inode, struct file *file)
1247 {
1248 	struct seq_file *m;
1249 	int ret;
1250 	struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1251 	struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1252 
1253 	ret = seq_open(file, &nfs_server_list_ops);
1254 	if (ret < 0)
1255 		return ret;
1256 
1257 	m = file->private_data;
1258 	m->private = net;
1259 
1260 	return 0;
1261 }
1262 
1263 /*
1264  * set up the iterator to start reading from the server list and return the first item
1265  */
1266 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1267 {
1268 	struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1269 
1270 	/* lock the list against modification */
1271 	spin_lock(&nn->nfs_client_lock);
1272 	return seq_list_start_head(&nn->nfs_client_list, *_pos);
1273 }
1274 
1275 /*
1276  * move to next server
1277  */
1278 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1279 {
1280 	struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1281 
1282 	return seq_list_next(v, &nn->nfs_client_list, pos);
1283 }
1284 
1285 /*
1286  * clean up after reading from the transports list
1287  */
1288 static void nfs_server_list_stop(struct seq_file *p, void *v)
1289 {
1290 	struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1291 
1292 	spin_unlock(&nn->nfs_client_lock);
1293 }
1294 
1295 /*
1296  * display a header line followed by a load of call lines
1297  */
1298 static int nfs_server_list_show(struct seq_file *m, void *v)
1299 {
1300 	struct nfs_client *clp;
1301 	struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1302 
1303 	/* display header on line 1 */
1304 	if (v == &nn->nfs_client_list) {
1305 		seq_puts(m, "NV SERVER   PORT USE HOSTNAME\n");
1306 		return 0;
1307 	}
1308 
1309 	/* display one transport per line on subsequent lines */
1310 	clp = list_entry(v, struct nfs_client, cl_share_link);
1311 
1312 	/* Check if the client is initialized */
1313 	if (clp->cl_cons_state != NFS_CS_READY)
1314 		return 0;
1315 
1316 	rcu_read_lock();
1317 	seq_printf(m, "v%u %s %s %3d %s\n",
1318 		   clp->rpc_ops->version,
1319 		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1320 		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1321 		   atomic_read(&clp->cl_count),
1322 		   clp->cl_hostname);
1323 	rcu_read_unlock();
1324 
1325 	return 0;
1326 }
1327 
1328 /*
1329  * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1330  */
1331 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1332 {
1333 	struct seq_file *m;
1334 	int ret;
1335 	struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1336 	struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1337 
1338 	ret = seq_open(file, &nfs_volume_list_ops);
1339 	if (ret < 0)
1340 		return ret;
1341 
1342 	m = file->private_data;
1343 	m->private = net;
1344 
1345 	return 0;
1346 }
1347 
1348 /*
1349  * set up the iterator to start reading from the volume list and return the first item
1350  */
1351 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1352 {
1353 	struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1354 
1355 	/* lock the list against modification */
1356 	spin_lock(&nn->nfs_client_lock);
1357 	return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1358 }
1359 
1360 /*
1361  * move to next volume
1362  */
1363 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1364 {
1365 	struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1366 
1367 	return seq_list_next(v, &nn->nfs_volume_list, pos);
1368 }
1369 
1370 /*
1371  * clean up after reading from the transports list
1372  */
1373 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1374 {
1375 	struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1376 
1377 	spin_unlock(&nn->nfs_client_lock);
1378 }
1379 
1380 /*
1381  * display a header line followed by a load of call lines
1382  */
1383 static int nfs_volume_list_show(struct seq_file *m, void *v)
1384 {
1385 	struct nfs_server *server;
1386 	struct nfs_client *clp;
1387 	char dev[8], fsid[17];
1388 	struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1389 
1390 	/* display header on line 1 */
1391 	if (v == &nn->nfs_volume_list) {
1392 		seq_puts(m, "NV SERVER   PORT DEV     FSID              FSC\n");
1393 		return 0;
1394 	}
1395 	/* display one transport per line on subsequent lines */
1396 	server = list_entry(v, struct nfs_server, master_link);
1397 	clp = server->nfs_client;
1398 
1399 	snprintf(dev, 8, "%u:%u",
1400 		 MAJOR(server->s_dev), MINOR(server->s_dev));
1401 
1402 	snprintf(fsid, 17, "%llx:%llx",
1403 		 (unsigned long long) server->fsid.major,
1404 		 (unsigned long long) server->fsid.minor);
1405 
1406 	rcu_read_lock();
1407 	seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
1408 		   clp->rpc_ops->version,
1409 		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1410 		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1411 		   dev,
1412 		   fsid,
1413 		   nfs_server_fscache_state(server));
1414 	rcu_read_unlock();
1415 
1416 	return 0;
1417 }
1418 
1419 /*
1420  * initialise the /proc/fs/nfsfs/ directory
1421  */
1422 int __init nfs_fs_proc_init(void)
1423 {
1424 	struct proc_dir_entry *p;
1425 
1426 	proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1427 	if (!proc_fs_nfs)
1428 		goto error_0;
1429 
1430 	/* a file of servers with which we're dealing */
1431 	p = proc_create("servers", S_IFREG|S_IRUGO,
1432 			proc_fs_nfs, &nfs_server_list_fops);
1433 	if (!p)
1434 		goto error_1;
1435 
1436 	/* a file of volumes that we have mounted */
1437 	p = proc_create("volumes", S_IFREG|S_IRUGO,
1438 			proc_fs_nfs, &nfs_volume_list_fops);
1439 	if (!p)
1440 		goto error_2;
1441 	return 0;
1442 
1443 error_2:
1444 	remove_proc_entry("servers", proc_fs_nfs);
1445 error_1:
1446 	remove_proc_entry("fs/nfsfs", NULL);
1447 error_0:
1448 	return -ENOMEM;
1449 }
1450 
1451 /*
1452  * clean up the /proc/fs/nfsfs/ directory
1453  */
1454 void nfs_fs_proc_exit(void)
1455 {
1456 	remove_proc_entry("volumes", proc_fs_nfs);
1457 	remove_proc_entry("servers", proc_fs_nfs);
1458 	remove_proc_entry("fs/nfsfs", NULL);
1459 }
1460 
1461 #endif /* CONFIG_PROC_FS */
1462