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 <net/ipv6.h>
40#include <linux/nfs_xdr.h>
41#include <linux/sunrpc/bc_xprt.h>
42
43#include <asm/system.h>
44
45#include "nfs4_fs.h"
46#include "callback.h"
47#include "delegation.h"
48#include "iostat.h"
49#include "internal.h"
50#include "fscache.h"
51
52#define NFSDBG_FACILITY		NFSDBG_CLIENT
53
54static DEFINE_SPINLOCK(nfs_client_lock);
55static LIST_HEAD(nfs_client_list);
56static LIST_HEAD(nfs_volume_list);
57static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
58
59/*
60 * RPC cruft for NFS
61 */
62static struct rpc_version *nfs_version[5] = {
63	[2]			= &nfs_version2,
64#ifdef CONFIG_NFS_V3
65	[3]			= &nfs_version3,
66#endif
67#ifdef CONFIG_NFS_V4
68	[4]			= &nfs_version4,
69#endif
70};
71
72struct rpc_program nfs_program = {
73	.name			= "nfs",
74	.number			= NFS_PROGRAM,
75	.nrvers			= ARRAY_SIZE(nfs_version),
76	.version		= nfs_version,
77	.stats			= &nfs_rpcstat,
78	.pipe_dir_name		= "/nfs",
79};
80
81struct rpc_stat nfs_rpcstat = {
82	.program		= &nfs_program
83};
84
85
86#ifdef CONFIG_NFS_V3_ACL
87static struct rpc_stat		nfsacl_rpcstat = { &nfsacl_program };
88static struct rpc_version *	nfsacl_version[] = {
89	[3]			= &nfsacl_version3,
90};
91
92struct rpc_program		nfsacl_program = {
93	.name			= "nfsacl",
94	.number			= NFS_ACL_PROGRAM,
95	.nrvers			= ARRAY_SIZE(nfsacl_version),
96	.version		= nfsacl_version,
97	.stats			= &nfsacl_rpcstat,
98};
99#endif  /* CONFIG_NFS_V3_ACL */
100
101struct nfs_client_initdata {
102	const char *hostname;
103	const struct sockaddr *addr;
104	size_t addrlen;
105	const struct nfs_rpc_ops *rpc_ops;
106	int proto;
107	u32 minorversion;
108};
109
110/*
111 * Allocate a shared client record
112 *
113 * Since these are allocated/deallocated very rarely, we don't
114 * bother putting them in a slab cache...
115 */
116static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
117{
118	struct nfs_client *clp;
119	struct rpc_cred *cred;
120	int err = -ENOMEM;
121
122	if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
123		goto error_0;
124
125	clp->rpc_ops = cl_init->rpc_ops;
126
127	atomic_set(&clp->cl_count, 1);
128	clp->cl_cons_state = NFS_CS_INITING;
129
130	memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
131	clp->cl_addrlen = cl_init->addrlen;
132
133	if (cl_init->hostname) {
134		err = -ENOMEM;
135		clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
136		if (!clp->cl_hostname)
137			goto error_cleanup;
138	}
139
140	INIT_LIST_HEAD(&clp->cl_superblocks);
141	clp->cl_rpcclient = ERR_PTR(-EINVAL);
142
143	clp->cl_proto = cl_init->proto;
144
145#ifdef CONFIG_NFS_V4
146	INIT_LIST_HEAD(&clp->cl_delegations);
147	spin_lock_init(&clp->cl_lock);
148	INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
149	rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
150	clp->cl_boot_time = CURRENT_TIME;
151	clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
152	clp->cl_minorversion = cl_init->minorversion;
153	clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
154#endif
155	cred = rpc_lookup_machine_cred();
156	if (!IS_ERR(cred))
157		clp->cl_machine_cred = cred;
158
159	nfs_fscache_get_client_cookie(clp);
160
161	return clp;
162
163error_cleanup:
164	kfree(clp);
165error_0:
166	return ERR_PTR(err);
167}
168
169#ifdef CONFIG_NFS_V4
170/*
171 * Clears/puts all minor version specific parts from an nfs_client struct
172 * reverting it to minorversion 0.
173 */
174static void nfs4_clear_client_minor_version(struct nfs_client *clp)
175{
176#ifdef CONFIG_NFS_V4_1
177	if (nfs4_has_session(clp)) {
178		nfs4_destroy_session(clp->cl_session);
179		clp->cl_session = NULL;
180	}
181
182	clp->cl_mvops = nfs_v4_minor_ops[0];
183#endif /* CONFIG_NFS_V4_1 */
184}
185
186/*
187 * Destroy the NFS4 callback service
188 */
189static void nfs4_destroy_callback(struct nfs_client *clp)
190{
191	if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
192		nfs_callback_down(clp->cl_mvops->minor_version);
193}
194
195static void nfs4_shutdown_client(struct nfs_client *clp)
196{
197	if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
198		nfs4_kill_renewd(clp);
199	nfs4_clear_client_minor_version(clp);
200	nfs4_destroy_callback(clp);
201	if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
202		nfs_idmap_delete(clp);
203
204	rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
205}
206#else
207static void nfs4_shutdown_client(struct nfs_client *clp)
208{
209}
210#endif /* CONFIG_NFS_V4 */
211
212/*
213 * Destroy a shared client record
214 */
215static void nfs_free_client(struct nfs_client *clp)
216{
217	dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
218
219	nfs4_shutdown_client(clp);
220
221	nfs_fscache_release_client_cookie(clp);
222
223	/* -EIO all pending I/O */
224	if (!IS_ERR(clp->cl_rpcclient))
225		rpc_shutdown_client(clp->cl_rpcclient);
226
227	if (clp->cl_machine_cred != NULL)
228		put_rpccred(clp->cl_machine_cred);
229
230	kfree(clp->cl_hostname);
231	kfree(clp);
232
233	dprintk("<-- nfs_free_client()\n");
234}
235
236/*
237 * Release a reference to a shared client record
238 */
239void nfs_put_client(struct nfs_client *clp)
240{
241	if (!clp)
242		return;
243
244	dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
245
246	if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
247		list_del(&clp->cl_share_link);
248		spin_unlock(&nfs_client_lock);
249
250		BUG_ON(!list_empty(&clp->cl_superblocks));
251
252		nfs_free_client(clp);
253	}
254}
255
256#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
257/*
258 * Test if two ip6 socket addresses refer to the same socket by
259 * comparing relevant fields. The padding bytes specifically, are not
260 * compared. sin6_flowinfo is not compared because it only affects QoS
261 * and sin6_scope_id is only compared if the address is "link local"
262 * because "link local" addresses need only be unique to a specific
263 * link. Conversely, ordinary unicast addresses might have different
264 * sin6_scope_id.
265 *
266 * The caller should ensure both socket addresses are AF_INET6.
267 */
268static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
269				      const struct sockaddr *sa2)
270{
271	const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
272	const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
273
274	if (ipv6_addr_scope(&sin1->sin6_addr) == IPV6_ADDR_SCOPE_LINKLOCAL &&
275	    sin1->sin6_scope_id != sin2->sin6_scope_id)
276		return 0;
277
278	return ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr);
279}
280#else	/* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
281static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
282				      const struct sockaddr *sa2)
283{
284	return 0;
285}
286#endif
287
288/*
289 * Test if two ip4 socket addresses refer to the same socket, by
290 * comparing relevant fields. The padding bytes specifically, are
291 * not compared.
292 *
293 * The caller should ensure both socket addresses are AF_INET.
294 */
295static int nfs_sockaddr_match_ipaddr4(const struct sockaddr *sa1,
296				      const struct sockaddr *sa2)
297{
298	const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
299	const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
300
301	return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
302}
303
304static int nfs_sockaddr_cmp_ip6(const struct sockaddr *sa1,
305				const struct sockaddr *sa2)
306{
307	const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
308	const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
309
310	return nfs_sockaddr_match_ipaddr6(sa1, sa2) &&
311		(sin1->sin6_port == sin2->sin6_port);
312}
313
314static int nfs_sockaddr_cmp_ip4(const struct sockaddr *sa1,
315				const struct sockaddr *sa2)
316{
317	const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
318	const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
319
320	return nfs_sockaddr_match_ipaddr4(sa1, sa2) &&
321		(sin1->sin_port == sin2->sin_port);
322}
323
324/*
325 * Test if two socket addresses represent the same actual socket,
326 * by comparing (only) relevant fields, excluding the port number.
327 */
328static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
329				     const struct sockaddr *sa2)
330{
331	if (sa1->sa_family != sa2->sa_family)
332		return 0;
333
334	switch (sa1->sa_family) {
335	case AF_INET:
336		return nfs_sockaddr_match_ipaddr4(sa1, sa2);
337	case AF_INET6:
338		return nfs_sockaddr_match_ipaddr6(sa1, sa2);
339	}
340	return 0;
341}
342
343/*
344 * Test if two socket addresses represent the same actual socket,
345 * by comparing (only) relevant fields, including the port number.
346 */
347static int nfs_sockaddr_cmp(const struct sockaddr *sa1,
348			    const struct sockaddr *sa2)
349{
350	if (sa1->sa_family != sa2->sa_family)
351		return 0;
352
353	switch (sa1->sa_family) {
354	case AF_INET:
355		return nfs_sockaddr_cmp_ip4(sa1, sa2);
356	case AF_INET6:
357		return nfs_sockaddr_cmp_ip6(sa1, sa2);
358	}
359	return 0;
360}
361
362/*
363 * Find a client by IP address and protocol version
364 * - returns NULL if no such client
365 */
366struct nfs_client *nfs_find_client(const struct sockaddr *addr, u32 nfsversion)
367{
368	struct nfs_client *clp;
369
370	spin_lock(&nfs_client_lock);
371	list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
372		struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
373
374		/* Don't match clients that failed to initialise properly */
375		if (!(clp->cl_cons_state == NFS_CS_READY ||
376		      clp->cl_cons_state == NFS_CS_SESSION_INITING))
377			continue;
378
379		/* Different NFS versions cannot share the same nfs_client */
380		if (clp->rpc_ops->version != nfsversion)
381			continue;
382
383		/* Match only the IP address, not the port number */
384		if (!nfs_sockaddr_match_ipaddr(addr, clap))
385			continue;
386
387		atomic_inc(&clp->cl_count);
388		spin_unlock(&nfs_client_lock);
389		return clp;
390	}
391	spin_unlock(&nfs_client_lock);
392	return NULL;
393}
394
395/*
396 * Find a client by IP address and protocol version
397 * - returns NULL if no such client
398 */
399struct nfs_client *nfs_find_client_next(struct nfs_client *clp)
400{
401	struct sockaddr *sap = (struct sockaddr *)&clp->cl_addr;
402	u32 nfsvers = clp->rpc_ops->version;
403
404	spin_lock(&nfs_client_lock);
405	list_for_each_entry_continue(clp, &nfs_client_list, cl_share_link) {
406		struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
407
408		/* Don't match clients that failed to initialise properly */
409		if (clp->cl_cons_state != NFS_CS_READY)
410			continue;
411
412		/* Different NFS versions cannot share the same nfs_client */
413		if (clp->rpc_ops->version != nfsvers)
414			continue;
415
416		/* Match only the IP address, not the port number */
417		if (!nfs_sockaddr_match_ipaddr(sap, clap))
418			continue;
419
420		atomic_inc(&clp->cl_count);
421		spin_unlock(&nfs_client_lock);
422		return clp;
423	}
424	spin_unlock(&nfs_client_lock);
425	return NULL;
426}
427
428/*
429 * Find an nfs_client on the list that matches the initialisation data
430 * that is supplied.
431 */
432static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
433{
434	struct nfs_client *clp;
435	const struct sockaddr *sap = data->addr;
436
437	list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
438	        const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
439		/* Don't match clients that failed to initialise properly */
440		if (clp->cl_cons_state < 0)
441			continue;
442
443		/* Different NFS versions cannot share the same nfs_client */
444		if (clp->rpc_ops != data->rpc_ops)
445			continue;
446
447		if (clp->cl_proto != data->proto)
448			continue;
449		/* Match nfsv4 minorversion */
450		if (clp->cl_minorversion != data->minorversion)
451			continue;
452		/* Match the full socket address */
453		if (!nfs_sockaddr_cmp(sap, clap))
454			continue;
455
456		atomic_inc(&clp->cl_count);
457		return clp;
458	}
459	return NULL;
460}
461
462/*
463 * Look up a client by IP address and protocol version
464 * - creates a new record if one doesn't yet exist
465 */
466static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
467{
468	struct nfs_client *clp, *new = NULL;
469	int error;
470
471	dprintk("--> nfs_get_client(%s,v%u)\n",
472		cl_init->hostname ?: "", cl_init->rpc_ops->version);
473
474	/* see if the client already exists */
475	do {
476		spin_lock(&nfs_client_lock);
477
478		clp = nfs_match_client(cl_init);
479		if (clp)
480			goto found_client;
481		if (new)
482			goto install_client;
483
484		spin_unlock(&nfs_client_lock);
485
486		new = nfs_alloc_client(cl_init);
487	} while (!IS_ERR(new));
488
489	dprintk("--> nfs_get_client() = %ld [failed]\n", PTR_ERR(new));
490	return new;
491
492	/* install a new client and return with it unready */
493install_client:
494	clp = new;
495	list_add(&clp->cl_share_link, &nfs_client_list);
496	spin_unlock(&nfs_client_lock);
497	dprintk("--> nfs_get_client() = %p [new]\n", clp);
498	return clp;
499
500	/* found an existing client
501	 * - make sure it's ready before returning
502	 */
503found_client:
504	spin_unlock(&nfs_client_lock);
505
506	if (new)
507		nfs_free_client(new);
508
509	error = wait_event_killable(nfs_client_active_wq,
510				clp->cl_cons_state < NFS_CS_INITING);
511	if (error < 0) {
512		nfs_put_client(clp);
513		return ERR_PTR(-ERESTARTSYS);
514	}
515
516	if (clp->cl_cons_state < NFS_CS_READY) {
517		error = clp->cl_cons_state;
518		nfs_put_client(clp);
519		return ERR_PTR(error);
520	}
521
522	BUG_ON(clp->cl_cons_state != NFS_CS_READY);
523
524	dprintk("--> nfs_get_client() = %p [share]\n", clp);
525	return clp;
526}
527
528/*
529 * Mark a server as ready or failed
530 */
531void nfs_mark_client_ready(struct nfs_client *clp, int state)
532{
533	clp->cl_cons_state = state;
534	wake_up_all(&nfs_client_active_wq);
535}
536
537/*
538 * With sessions, the client is not marked ready until after a
539 * successful EXCHANGE_ID and CREATE_SESSION.
540 *
541 * Map errors cl_cons_state errors to EPROTONOSUPPORT to indicate
542 * other versions of NFS can be tried.
543 */
544int nfs4_check_client_ready(struct nfs_client *clp)
545{
546	if (!nfs4_has_session(clp))
547		return 0;
548	if (clp->cl_cons_state < NFS_CS_READY)
549		return -EPROTONOSUPPORT;
550	return 0;
551}
552
553/*
554 * Initialise the timeout values for a connection
555 */
556static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
557				    unsigned int timeo, unsigned int retrans)
558{
559	to->to_initval = timeo * HZ / 10;
560	to->to_retries = retrans;
561
562	switch (proto) {
563	case XPRT_TRANSPORT_TCP:
564	case XPRT_TRANSPORT_RDMA:
565		if (to->to_retries == 0)
566			to->to_retries = NFS_DEF_TCP_RETRANS;
567		if (to->to_initval == 0)
568			to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
569		if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
570			to->to_initval = NFS_MAX_TCP_TIMEOUT;
571		to->to_increment = to->to_initval;
572		to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
573		if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
574			to->to_maxval = NFS_MAX_TCP_TIMEOUT;
575		if (to->to_maxval < to->to_initval)
576			to->to_maxval = to->to_initval;
577		to->to_exponential = 0;
578		break;
579	case XPRT_TRANSPORT_UDP:
580		if (to->to_retries == 0)
581			to->to_retries = NFS_DEF_UDP_RETRANS;
582		if (!to->to_initval)
583			to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
584		if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
585			to->to_initval = NFS_MAX_UDP_TIMEOUT;
586		to->to_maxval = NFS_MAX_UDP_TIMEOUT;
587		to->to_exponential = 1;
588		break;
589	default:
590		BUG();
591	}
592}
593
594/*
595 * Create an RPC client handle
596 */
597static int nfs_create_rpc_client(struct nfs_client *clp,
598				 const struct rpc_timeout *timeparms,
599				 rpc_authflavor_t flavor,
600				 int discrtry, int noresvport)
601{
602	struct rpc_clnt		*clnt = NULL;
603	struct rpc_create_args args = {
604		.protocol	= clp->cl_proto,
605		.address	= (struct sockaddr *)&clp->cl_addr,
606		.addrsize	= clp->cl_addrlen,
607		.timeout	= timeparms,
608		.servername	= clp->cl_hostname,
609		.program	= &nfs_program,
610		.version	= clp->rpc_ops->version,
611		.authflavor	= flavor,
612	};
613
614	if (discrtry)
615		args.flags |= RPC_CLNT_CREATE_DISCRTRY;
616	if (noresvport)
617		args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
618
619	if (!IS_ERR(clp->cl_rpcclient))
620		return 0;
621
622	clnt = rpc_create(&args);
623	if (IS_ERR(clnt)) {
624		dprintk("%s: cannot create RPC client. Error = %ld\n",
625				__func__, PTR_ERR(clnt));
626		return PTR_ERR(clnt);
627	}
628
629	clp->cl_rpcclient = clnt;
630	return 0;
631}
632
633/*
634 * Version 2 or 3 client destruction
635 */
636static void nfs_destroy_server(struct nfs_server *server)
637{
638	if (!(server->flags & NFS_MOUNT_NONLM))
639		nlmclnt_done(server->nlm_host);
640}
641
642/*
643 * Version 2 or 3 lockd setup
644 */
645static int nfs_start_lockd(struct nfs_server *server)
646{
647	struct nlm_host *host;
648	struct nfs_client *clp = server->nfs_client;
649	struct nlmclnt_initdata nlm_init = {
650		.hostname	= clp->cl_hostname,
651		.address	= (struct sockaddr *)&clp->cl_addr,
652		.addrlen	= clp->cl_addrlen,
653		.nfs_version	= clp->rpc_ops->version,
654		.noresvport	= server->flags & NFS_MOUNT_NORESVPORT ?
655					1 : 0,
656	};
657
658	if (nlm_init.nfs_version > 3)
659		return 0;
660	if (server->flags & NFS_MOUNT_NONLM)
661		return 0;
662
663	switch (clp->cl_proto) {
664		default:
665			nlm_init.protocol = IPPROTO_TCP;
666			break;
667		case XPRT_TRANSPORT_UDP:
668			nlm_init.protocol = IPPROTO_UDP;
669	}
670
671	host = nlmclnt_init(&nlm_init);
672	if (IS_ERR(host))
673		return PTR_ERR(host);
674
675	server->nlm_host = host;
676	server->destroy = nfs_destroy_server;
677	return 0;
678}
679
680/*
681 * Initialise an NFSv3 ACL client connection
682 */
683#ifdef CONFIG_NFS_V3_ACL
684static void nfs_init_server_aclclient(struct nfs_server *server)
685{
686	if (server->nfs_client->rpc_ops->version != 3)
687		goto out_noacl;
688	if (server->flags & NFS_MOUNT_NOACL)
689		goto out_noacl;
690
691	server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
692	if (IS_ERR(server->client_acl))
693		goto out_noacl;
694
695	/* No errors! Assume that Sun nfsacls are supported */
696	server->caps |= NFS_CAP_ACLS;
697	return;
698
699out_noacl:
700	server->caps &= ~NFS_CAP_ACLS;
701}
702#else
703static inline void nfs_init_server_aclclient(struct nfs_server *server)
704{
705	server->flags &= ~NFS_MOUNT_NOACL;
706	server->caps &= ~NFS_CAP_ACLS;
707}
708#endif
709
710/*
711 * Create a general RPC client
712 */
713static int nfs_init_server_rpcclient(struct nfs_server *server,
714		const struct rpc_timeout *timeo,
715		rpc_authflavor_t pseudoflavour)
716{
717	struct nfs_client *clp = server->nfs_client;
718
719	server->client = rpc_clone_client(clp->cl_rpcclient);
720	if (IS_ERR(server->client)) {
721		dprintk("%s: couldn't create rpc_client!\n", __func__);
722		return PTR_ERR(server->client);
723	}
724
725	memcpy(&server->client->cl_timeout_default,
726			timeo,
727			sizeof(server->client->cl_timeout_default));
728	server->client->cl_timeout = &server->client->cl_timeout_default;
729
730	if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
731		struct rpc_auth *auth;
732
733		auth = rpcauth_create(pseudoflavour, server->client);
734		if (IS_ERR(auth)) {
735			dprintk("%s: couldn't create credcache!\n", __func__);
736			return PTR_ERR(auth);
737		}
738	}
739	server->client->cl_softrtry = 0;
740	if (server->flags & NFS_MOUNT_SOFT)
741		server->client->cl_softrtry = 1;
742
743	return 0;
744}
745
746/*
747 * Initialise an NFS2 or NFS3 client
748 */
749static int nfs_init_client(struct nfs_client *clp,
750			   const struct rpc_timeout *timeparms,
751			   const struct nfs_parsed_mount_data *data)
752{
753	int error;
754
755	if (clp->cl_cons_state == NFS_CS_READY) {
756		/* the client is already initialised */
757		dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
758		return 0;
759	}
760
761	/*
762	 * Create a client RPC handle for doing FSSTAT with UNIX auth only
763	 * - RFC 2623, sec 2.3.2
764	 */
765	error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX,
766				      0, data->flags & NFS_MOUNT_NORESVPORT);
767	if (error < 0)
768		goto error;
769	nfs_mark_client_ready(clp, NFS_CS_READY);
770	return 0;
771
772error:
773	nfs_mark_client_ready(clp, error);
774	dprintk("<-- nfs_init_client() = xerror %d\n", error);
775	return error;
776}
777
778/*
779 * Create a version 2 or 3 client
780 */
781static int nfs_init_server(struct nfs_server *server,
782			   const struct nfs_parsed_mount_data *data)
783{
784	struct nfs_client_initdata cl_init = {
785		.hostname = data->nfs_server.hostname,
786		.addr = (const struct sockaddr *)&data->nfs_server.address,
787		.addrlen = data->nfs_server.addrlen,
788		.rpc_ops = &nfs_v2_clientops,
789		.proto = data->nfs_server.protocol,
790	};
791	struct rpc_timeout timeparms;
792	struct nfs_client *clp;
793	int error;
794
795	dprintk("--> nfs_init_server()\n");
796
797#ifdef CONFIG_NFS_V3
798	if (data->version == 3)
799		cl_init.rpc_ops = &nfs_v3_clientops;
800#endif
801
802	/* Allocate or find a client reference we can use */
803	clp = nfs_get_client(&cl_init);
804	if (IS_ERR(clp)) {
805		dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
806		return PTR_ERR(clp);
807	}
808
809	nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
810			data->timeo, data->retrans);
811	error = nfs_init_client(clp, &timeparms, data);
812	if (error < 0)
813		goto error;
814
815	server->nfs_client = clp;
816
817	/* Initialise the client representation from the mount data */
818	server->flags = data->flags;
819	server->options = data->options;
820	server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
821		NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
822		NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
823
824	if (data->rsize)
825		server->rsize = nfs_block_size(data->rsize, NULL);
826	if (data->wsize)
827		server->wsize = nfs_block_size(data->wsize, NULL);
828
829	server->acregmin = data->acregmin * HZ;
830	server->acregmax = data->acregmax * HZ;
831	server->acdirmin = data->acdirmin * HZ;
832	server->acdirmax = data->acdirmax * HZ;
833
834	/* Start lockd here, before we might error out */
835	error = nfs_start_lockd(server);
836	if (error < 0)
837		goto error;
838
839	server->port = data->nfs_server.port;
840
841	error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
842	if (error < 0)
843		goto error;
844
845	/* Preserve the values of mount_server-related mount options */
846	if (data->mount_server.addrlen) {
847		memcpy(&server->mountd_address, &data->mount_server.address,
848			data->mount_server.addrlen);
849		server->mountd_addrlen = data->mount_server.addrlen;
850	}
851	server->mountd_version = data->mount_server.version;
852	server->mountd_port = data->mount_server.port;
853	server->mountd_protocol = data->mount_server.protocol;
854
855	server->namelen  = data->namlen;
856	/* Create a client RPC handle for the NFSv3 ACL management interface */
857	nfs_init_server_aclclient(server);
858	dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
859	return 0;
860
861error:
862	server->nfs_client = NULL;
863	nfs_put_client(clp);
864	dprintk("<-- nfs_init_server() = xerror %d\n", error);
865	return error;
866}
867
868/*
869 * Load up the server record from information gained in an fsinfo record
870 */
871static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
872{
873	unsigned long max_rpc_payload;
874
875	/* Work out a lot of parameters */
876	if (server->rsize == 0)
877		server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
878	if (server->wsize == 0)
879		server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
880
881	if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
882		server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
883	if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
884		server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
885
886	max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
887	if (server->rsize > max_rpc_payload)
888		server->rsize = max_rpc_payload;
889	if (server->rsize > NFS_MAX_FILE_IO_SIZE)
890		server->rsize = NFS_MAX_FILE_IO_SIZE;
891	server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
892
893	server->backing_dev_info.name = "nfs";
894	server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
895
896	if (server->wsize > max_rpc_payload)
897		server->wsize = max_rpc_payload;
898	if (server->wsize > NFS_MAX_FILE_IO_SIZE)
899		server->wsize = NFS_MAX_FILE_IO_SIZE;
900	server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
901	server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
902
903	server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
904	if (server->dtsize > PAGE_CACHE_SIZE)
905		server->dtsize = PAGE_CACHE_SIZE;
906	if (server->dtsize > server->rsize)
907		server->dtsize = server->rsize;
908
909	if (server->flags & NFS_MOUNT_NOAC) {
910		server->acregmin = server->acregmax = 0;
911		server->acdirmin = server->acdirmax = 0;
912	}
913
914	server->maxfilesize = fsinfo->maxfilesize;
915
916	/* We're airborne Set socket buffersize */
917	rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
918}
919
920/*
921 * Probe filesystem information, including the FSID on v2/v3
922 */
923static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
924{
925	struct nfs_fsinfo fsinfo;
926	struct nfs_client *clp = server->nfs_client;
927	int error;
928
929	dprintk("--> nfs_probe_fsinfo()\n");
930
931	if (clp->rpc_ops->set_capabilities != NULL) {
932		error = clp->rpc_ops->set_capabilities(server, mntfh);
933		if (error < 0)
934			goto out_error;
935	}
936
937	fsinfo.fattr = fattr;
938	error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
939	if (error < 0)
940		goto out_error;
941
942	nfs_server_set_fsinfo(server, &fsinfo);
943
944	/* Get some general file system info */
945	if (server->namelen == 0) {
946		struct nfs_pathconf pathinfo;
947
948		pathinfo.fattr = fattr;
949		nfs_fattr_init(fattr);
950
951		if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
952			server->namelen = pathinfo.max_namelen;
953	}
954
955	dprintk("<-- nfs_probe_fsinfo() = 0\n");
956	return 0;
957
958out_error:
959	dprintk("nfs_probe_fsinfo: error = %d\n", -error);
960	return error;
961}
962
963/*
964 * Copy useful information when duplicating a server record
965 */
966static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
967{
968	target->flags = source->flags;
969	target->rsize = source->rsize;
970	target->wsize = source->wsize;
971	target->acregmin = source->acregmin;
972	target->acregmax = source->acregmax;
973	target->acdirmin = source->acdirmin;
974	target->acdirmax = source->acdirmax;
975	target->caps = source->caps;
976	target->options = source->options;
977}
978
979/*
980 * Allocate and initialise a server record
981 */
982static struct nfs_server *nfs_alloc_server(void)
983{
984	struct nfs_server *server;
985
986	server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
987	if (!server)
988		return NULL;
989
990	server->client = server->client_acl = ERR_PTR(-EINVAL);
991
992	/* Zero out the NFS state stuff */
993	INIT_LIST_HEAD(&server->client_link);
994	INIT_LIST_HEAD(&server->master_link);
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	return server;
1011}
1012
1013/*
1014 * Free up a server record
1015 */
1016void nfs_free_server(struct nfs_server *server)
1017{
1018	dprintk("--> nfs_free_server()\n");
1019
1020	spin_lock(&nfs_client_lock);
1021	list_del(&server->client_link);
1022	list_del(&server->master_link);
1023	spin_unlock(&nfs_client_lock);
1024
1025	if (server->destroy != NULL)
1026		server->destroy(server);
1027
1028	if (!IS_ERR(server->client_acl))
1029		rpc_shutdown_client(server->client_acl);
1030	if (!IS_ERR(server->client))
1031		rpc_shutdown_client(server->client);
1032
1033	nfs_put_client(server->nfs_client);
1034
1035	nfs_free_iostats(server->io_stats);
1036	bdi_destroy(&server->backing_dev_info);
1037	kfree(server);
1038	nfs_release_automount_timer();
1039	dprintk("<-- nfs_free_server()\n");
1040}
1041
1042/*
1043 * Create a version 2 or 3 volume record
1044 * - keyed on server and FSID
1045 */
1046struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
1047				     struct nfs_fh *mntfh)
1048{
1049	struct nfs_server *server;
1050	struct nfs_fattr *fattr;
1051	int error;
1052
1053	server = nfs_alloc_server();
1054	if (!server)
1055		return ERR_PTR(-ENOMEM);
1056
1057	error = -ENOMEM;
1058	fattr = nfs_alloc_fattr();
1059	if (fattr == NULL)
1060		goto error;
1061
1062	/* Get a client representation */
1063	error = nfs_init_server(server, data);
1064	if (error < 0)
1065		goto error;
1066
1067	BUG_ON(!server->nfs_client);
1068	BUG_ON(!server->nfs_client->rpc_ops);
1069	BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1070
1071	/* Probe the root fh to retrieve its FSID */
1072	error = nfs_probe_fsinfo(server, mntfh, fattr);
1073	if (error < 0)
1074		goto error;
1075	if (server->nfs_client->rpc_ops->version == 3) {
1076		if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1077			server->namelen = NFS3_MAXNAMLEN;
1078		if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
1079			server->caps |= NFS_CAP_READDIRPLUS;
1080	} else {
1081		if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1082			server->namelen = NFS2_MAXNAMLEN;
1083	}
1084
1085	if (!(fattr->valid & NFS_ATTR_FATTR)) {
1086		error = server->nfs_client->rpc_ops->getattr(server, mntfh, fattr);
1087		if (error < 0) {
1088			dprintk("nfs_create_server: getattr error = %d\n", -error);
1089			goto error;
1090		}
1091	}
1092	memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1093
1094	dprintk("Server FSID: %llx:%llx\n",
1095		(unsigned long long) server->fsid.major,
1096		(unsigned long long) server->fsid.minor);
1097
1098	spin_lock(&nfs_client_lock);
1099	list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1100	list_add_tail(&server->master_link, &nfs_volume_list);
1101	spin_unlock(&nfs_client_lock);
1102
1103	server->mount_time = jiffies;
1104	nfs_free_fattr(fattr);
1105	return server;
1106
1107error:
1108	nfs_free_fattr(fattr);
1109	nfs_free_server(server);
1110	return ERR_PTR(error);
1111}
1112
1113#ifdef CONFIG_NFS_V4
1114/*
1115 * Initialize the NFS4 callback service
1116 */
1117static int nfs4_init_callback(struct nfs_client *clp)
1118{
1119	int error;
1120
1121	if (clp->rpc_ops->version == 4) {
1122		if (nfs4_has_session(clp)) {
1123			error = xprt_setup_backchannel(
1124						clp->cl_rpcclient->cl_xprt,
1125						NFS41_BC_MIN_CALLBACKS);
1126			if (error < 0)
1127				return error;
1128		}
1129
1130		error = nfs_callback_up(clp->cl_mvops->minor_version,
1131					clp->cl_rpcclient->cl_xprt);
1132		if (error < 0) {
1133			dprintk("%s: failed to start callback. Error = %d\n",
1134				__func__, error);
1135			return error;
1136		}
1137		__set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
1138	}
1139	return 0;
1140}
1141
1142/*
1143 * Initialize the minor version specific parts of an NFS4 client record
1144 */
1145static int nfs4_init_client_minor_version(struct nfs_client *clp)
1146{
1147#if defined(CONFIG_NFS_V4_1)
1148	if (clp->cl_mvops->minor_version) {
1149		struct nfs4_session *session = NULL;
1150		/*
1151		 * Create the session and mark it expired.
1152		 * When a SEQUENCE operation encounters the expired session
1153		 * it will do session recovery to initialize it.
1154		 */
1155		session = nfs4_alloc_session(clp);
1156		if (!session)
1157			return -ENOMEM;
1158
1159		clp->cl_session = session;
1160		/*
1161		 * The create session reply races with the server back
1162		 * channel probe. Mark the client NFS_CS_SESSION_INITING
1163		 * so that the client back channel can find the
1164		 * nfs_client struct
1165		 */
1166		clp->cl_cons_state = NFS_CS_SESSION_INITING;
1167	}
1168#endif /* CONFIG_NFS_V4_1 */
1169
1170	return nfs4_init_callback(clp);
1171}
1172
1173/*
1174 * Initialise an NFS4 client record
1175 */
1176static int nfs4_init_client(struct nfs_client *clp,
1177		const struct rpc_timeout *timeparms,
1178		const char *ip_addr,
1179		rpc_authflavor_t authflavour,
1180		int flags)
1181{
1182	int error;
1183
1184	if (clp->cl_cons_state == NFS_CS_READY) {
1185		/* the client is initialised already */
1186		dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
1187		return 0;
1188	}
1189
1190	/* Check NFS protocol revision and initialize RPC op vector */
1191	clp->rpc_ops = &nfs_v4_clientops;
1192
1193	error = nfs_create_rpc_client(clp, timeparms, authflavour,
1194				      1, flags & NFS_MOUNT_NORESVPORT);
1195	if (error < 0)
1196		goto error;
1197	strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
1198
1199	error = nfs_idmap_new(clp);
1200	if (error < 0) {
1201		dprintk("%s: failed to create idmapper. Error = %d\n",
1202			__func__, error);
1203		goto error;
1204	}
1205	__set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
1206
1207	error = nfs4_init_client_minor_version(clp);
1208	if (error < 0)
1209		goto error;
1210
1211	if (!nfs4_has_session(clp))
1212		nfs_mark_client_ready(clp, NFS_CS_READY);
1213	return 0;
1214
1215error:
1216	nfs_mark_client_ready(clp, error);
1217	dprintk("<-- nfs4_init_client() = xerror %d\n", error);
1218	return error;
1219}
1220
1221/*
1222 * Set up an NFS4 client
1223 */
1224static int nfs4_set_client(struct nfs_server *server,
1225		const char *hostname,
1226		const struct sockaddr *addr,
1227		const size_t addrlen,
1228		const char *ip_addr,
1229		rpc_authflavor_t authflavour,
1230		int proto, const struct rpc_timeout *timeparms,
1231		u32 minorversion)
1232{
1233	struct nfs_client_initdata cl_init = {
1234		.hostname = hostname,
1235		.addr = addr,
1236		.addrlen = addrlen,
1237		.rpc_ops = &nfs_v4_clientops,
1238		.proto = proto,
1239		.minorversion = minorversion,
1240	};
1241	struct nfs_client *clp;
1242	int error;
1243
1244	dprintk("--> nfs4_set_client()\n");
1245
1246	/* Allocate or find a client reference we can use */
1247	clp = nfs_get_client(&cl_init);
1248	if (IS_ERR(clp)) {
1249		error = PTR_ERR(clp);
1250		goto error;
1251	}
1252	error = nfs4_init_client(clp, timeparms, ip_addr, authflavour,
1253					server->flags);
1254	if (error < 0)
1255		goto error_put;
1256
1257	server->nfs_client = clp;
1258	dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
1259	return 0;
1260
1261error_put:
1262	nfs_put_client(clp);
1263error:
1264	dprintk("<-- nfs4_set_client() = xerror %d\n", error);
1265	return error;
1266}
1267
1268
1269/*
1270 * Session has been established, and the client marked ready.
1271 * Set the mount rsize and wsize with negotiated fore channel
1272 * attributes which will be bound checked in nfs_server_set_fsinfo.
1273 */
1274static void nfs4_session_set_rwsize(struct nfs_server *server)
1275{
1276#ifdef CONFIG_NFS_V4_1
1277	struct nfs4_session *sess;
1278	u32 server_resp_sz;
1279	u32 server_rqst_sz;
1280
1281	if (!nfs4_has_session(server->nfs_client))
1282		return;
1283	sess = server->nfs_client->cl_session;
1284	server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1285	server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1286
1287	if (server->rsize > server_resp_sz)
1288		server->rsize = server_resp_sz;
1289	if (server->wsize > server_rqst_sz)
1290		server->wsize = server_rqst_sz;
1291#endif /* CONFIG_NFS_V4_1 */
1292}
1293
1294static int nfs4_server_common_setup(struct nfs_server *server,
1295		struct nfs_fh *mntfh)
1296{
1297	struct nfs_fattr *fattr;
1298	int error;
1299
1300	BUG_ON(!server->nfs_client);
1301	BUG_ON(!server->nfs_client->rpc_ops);
1302	BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1303
1304	fattr = nfs_alloc_fattr();
1305	if (fattr == NULL)
1306		return -ENOMEM;
1307
1308	/* We must ensure the session is initialised first */
1309	error = nfs4_init_session(server);
1310	if (error < 0)
1311		goto out;
1312
1313	/* Probe the root fh to retrieve its FSID and filehandle */
1314	error = nfs4_get_rootfh(server, mntfh);
1315	if (error < 0)
1316		goto out;
1317
1318	dprintk("Server FSID: %llx:%llx\n",
1319			(unsigned long long) server->fsid.major,
1320			(unsigned long long) server->fsid.minor);
1321	dprintk("Mount FH: %d\n", mntfh->size);
1322
1323	nfs4_session_set_rwsize(server);
1324
1325	error = nfs_probe_fsinfo(server, mntfh, fattr);
1326	if (error < 0)
1327		goto out;
1328
1329	if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1330		server->namelen = NFS4_MAXNAMLEN;
1331
1332	spin_lock(&nfs_client_lock);
1333	list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1334	list_add_tail(&server->master_link, &nfs_volume_list);
1335	spin_unlock(&nfs_client_lock);
1336
1337	server->mount_time = jiffies;
1338out:
1339	nfs_free_fattr(fattr);
1340	return error;
1341}
1342
1343/*
1344 * Create a version 4 volume record
1345 */
1346static int nfs4_init_server(struct nfs_server *server,
1347		const struct nfs_parsed_mount_data *data)
1348{
1349	struct rpc_timeout timeparms;
1350	int error;
1351
1352	dprintk("--> nfs4_init_server()\n");
1353
1354	nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1355			data->timeo, data->retrans);
1356
1357	/* Initialise the client representation from the mount data */
1358	server->flags = data->flags;
1359	server->caps |= NFS_CAP_ATOMIC_OPEN|NFS_CAP_CHANGE_ATTR|
1360		NFS_CAP_POSIX_LOCK;
1361	server->options = data->options;
1362
1363	/* Get a client record */
1364	error = nfs4_set_client(server,
1365			data->nfs_server.hostname,
1366			(const struct sockaddr *)&data->nfs_server.address,
1367			data->nfs_server.addrlen,
1368			data->client_address,
1369			data->auth_flavors[0],
1370			data->nfs_server.protocol,
1371			&timeparms,
1372			data->minorversion);
1373	if (error < 0)
1374		goto error;
1375
1376	if (data->rsize)
1377		server->rsize = nfs_block_size(data->rsize, NULL);
1378	if (data->wsize)
1379		server->wsize = nfs_block_size(data->wsize, NULL);
1380
1381	server->acregmin = data->acregmin * HZ;
1382	server->acregmax = data->acregmax * HZ;
1383	server->acdirmin = data->acdirmin * HZ;
1384	server->acdirmax = data->acdirmax * HZ;
1385
1386	server->port = data->nfs_server.port;
1387
1388	error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1389
1390error:
1391	/* Done */
1392	dprintk("<-- nfs4_init_server() = %d\n", error);
1393	return error;
1394}
1395
1396/*
1397 * Create a version 4 volume record
1398 * - keyed on server and FSID
1399 */
1400struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1401				      struct nfs_fh *mntfh)
1402{
1403	struct nfs_server *server;
1404	int error;
1405
1406	dprintk("--> nfs4_create_server()\n");
1407
1408	server = nfs_alloc_server();
1409	if (!server)
1410		return ERR_PTR(-ENOMEM);
1411
1412	/* set up the general RPC client */
1413	error = nfs4_init_server(server, data);
1414	if (error < 0)
1415		goto error;
1416
1417	error = nfs4_server_common_setup(server, mntfh);
1418	if (error < 0)
1419		goto error;
1420
1421	dprintk("<-- nfs4_create_server() = %p\n", server);
1422	return server;
1423
1424error:
1425	nfs_free_server(server);
1426	dprintk("<-- nfs4_create_server() = error %d\n", error);
1427	return ERR_PTR(error);
1428}
1429
1430/*
1431 * Create an NFS4 referral server record
1432 */
1433struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1434					       struct nfs_fh *mntfh)
1435{
1436	struct nfs_client *parent_client;
1437	struct nfs_server *server, *parent_server;
1438	int error;
1439
1440	dprintk("--> nfs4_create_referral_server()\n");
1441
1442	server = nfs_alloc_server();
1443	if (!server)
1444		return ERR_PTR(-ENOMEM);
1445
1446	parent_server = NFS_SB(data->sb);
1447	parent_client = parent_server->nfs_client;
1448
1449	/* Initialise the client representation from the parent server */
1450	nfs_server_copy_userdata(server, parent_server);
1451	server->caps |= NFS_CAP_ATOMIC_OPEN|NFS_CAP_CHANGE_ATTR;
1452
1453	/* Get a client representation.
1454	 * Note: NFSv4 always uses TCP, */
1455	error = nfs4_set_client(server, data->hostname,
1456				data->addr,
1457				data->addrlen,
1458				parent_client->cl_ipaddr,
1459				data->authflavor,
1460				parent_server->client->cl_xprt->prot,
1461				parent_server->client->cl_timeout,
1462				parent_client->cl_mvops->minor_version);
1463	if (error < 0)
1464		goto error;
1465
1466	error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1467	if (error < 0)
1468		goto error;
1469
1470	error = nfs4_server_common_setup(server, mntfh);
1471	if (error < 0)
1472		goto error;
1473
1474	dprintk("<-- nfs_create_referral_server() = %p\n", server);
1475	return server;
1476
1477error:
1478	nfs_free_server(server);
1479	dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1480	return ERR_PTR(error);
1481}
1482
1483#endif /* CONFIG_NFS_V4 */
1484
1485/*
1486 * Clone an NFS2, NFS3 or NFS4 server record
1487 */
1488struct nfs_server *nfs_clone_server(struct nfs_server *source,
1489				    struct nfs_fh *fh,
1490				    struct nfs_fattr *fattr)
1491{
1492	struct nfs_server *server;
1493	struct nfs_fattr *fattr_fsinfo;
1494	int error;
1495
1496	dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1497		(unsigned long long) fattr->fsid.major,
1498		(unsigned long long) fattr->fsid.minor);
1499
1500	server = nfs_alloc_server();
1501	if (!server)
1502		return ERR_PTR(-ENOMEM);
1503
1504	error = -ENOMEM;
1505	fattr_fsinfo = nfs_alloc_fattr();
1506	if (fattr_fsinfo == NULL)
1507		goto out_free_server;
1508
1509	/* Copy data from the source */
1510	server->nfs_client = source->nfs_client;
1511	atomic_inc(&server->nfs_client->cl_count);
1512	nfs_server_copy_userdata(server, source);
1513
1514	server->fsid = fattr->fsid;
1515
1516	error = nfs_init_server_rpcclient(server,
1517			source->client->cl_timeout,
1518			source->client->cl_auth->au_flavor);
1519	if (error < 0)
1520		goto out_free_server;
1521	if (!IS_ERR(source->client_acl))
1522		nfs_init_server_aclclient(server);
1523
1524	/* probe the filesystem info for this server filesystem */
1525	error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1526	if (error < 0)
1527		goto out_free_server;
1528
1529	if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1530		server->namelen = NFS4_MAXNAMLEN;
1531
1532	dprintk("Cloned FSID: %llx:%llx\n",
1533		(unsigned long long) server->fsid.major,
1534		(unsigned long long) server->fsid.minor);
1535
1536	error = nfs_start_lockd(server);
1537	if (error < 0)
1538		goto out_free_server;
1539
1540	spin_lock(&nfs_client_lock);
1541	list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1542	list_add_tail(&server->master_link, &nfs_volume_list);
1543	spin_unlock(&nfs_client_lock);
1544
1545	server->mount_time = jiffies;
1546
1547	nfs_free_fattr(fattr_fsinfo);
1548	dprintk("<-- nfs_clone_server() = %p\n", server);
1549	return server;
1550
1551out_free_server:
1552	nfs_free_fattr(fattr_fsinfo);
1553	nfs_free_server(server);
1554	dprintk("<-- nfs_clone_server() = error %d\n", error);
1555	return ERR_PTR(error);
1556}
1557
1558#ifdef CONFIG_PROC_FS
1559static struct proc_dir_entry *proc_fs_nfs;
1560
1561static int nfs_server_list_open(struct inode *inode, struct file *file);
1562static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1563static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1564static void nfs_server_list_stop(struct seq_file *p, void *v);
1565static int nfs_server_list_show(struct seq_file *m, void *v);
1566
1567static const struct seq_operations nfs_server_list_ops = {
1568	.start	= nfs_server_list_start,
1569	.next	= nfs_server_list_next,
1570	.stop	= nfs_server_list_stop,
1571	.show	= nfs_server_list_show,
1572};
1573
1574static const struct file_operations nfs_server_list_fops = {
1575	.open		= nfs_server_list_open,
1576	.read		= seq_read,
1577	.llseek		= seq_lseek,
1578	.release	= seq_release,
1579	.owner		= THIS_MODULE,
1580};
1581
1582static int nfs_volume_list_open(struct inode *inode, struct file *file);
1583static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1584static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1585static void nfs_volume_list_stop(struct seq_file *p, void *v);
1586static int nfs_volume_list_show(struct seq_file *m, void *v);
1587
1588static const struct seq_operations nfs_volume_list_ops = {
1589	.start	= nfs_volume_list_start,
1590	.next	= nfs_volume_list_next,
1591	.stop	= nfs_volume_list_stop,
1592	.show	= nfs_volume_list_show,
1593};
1594
1595static const struct file_operations nfs_volume_list_fops = {
1596	.open		= nfs_volume_list_open,
1597	.read		= seq_read,
1598	.llseek		= seq_lseek,
1599	.release	= seq_release,
1600	.owner		= THIS_MODULE,
1601};
1602
1603/*
1604 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1605 * we're dealing
1606 */
1607static int nfs_server_list_open(struct inode *inode, struct file *file)
1608{
1609	struct seq_file *m;
1610	int ret;
1611
1612	ret = seq_open(file, &nfs_server_list_ops);
1613	if (ret < 0)
1614		return ret;
1615
1616	m = file->private_data;
1617	m->private = PDE(inode)->data;
1618
1619	return 0;
1620}
1621
1622/*
1623 * set up the iterator to start reading from the server list and return the first item
1624 */
1625static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1626{
1627	/* lock the list against modification */
1628	spin_lock(&nfs_client_lock);
1629	return seq_list_start_head(&nfs_client_list, *_pos);
1630}
1631
1632/*
1633 * move to next server
1634 */
1635static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1636{
1637	return seq_list_next(v, &nfs_client_list, pos);
1638}
1639
1640/*
1641 * clean up after reading from the transports list
1642 */
1643static void nfs_server_list_stop(struct seq_file *p, void *v)
1644{
1645	spin_unlock(&nfs_client_lock);
1646}
1647
1648/*
1649 * display a header line followed by a load of call lines
1650 */
1651static int nfs_server_list_show(struct seq_file *m, void *v)
1652{
1653	struct nfs_client *clp;
1654
1655	/* display header on line 1 */
1656	if (v == &nfs_client_list) {
1657		seq_puts(m, "NV SERVER   PORT USE HOSTNAME\n");
1658		return 0;
1659	}
1660
1661	/* display one transport per line on subsequent lines */
1662	clp = list_entry(v, struct nfs_client, cl_share_link);
1663
1664	seq_printf(m, "v%u %s %s %3d %s\n",
1665		   clp->rpc_ops->version,
1666		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1667		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1668		   atomic_read(&clp->cl_count),
1669		   clp->cl_hostname);
1670
1671	return 0;
1672}
1673
1674/*
1675 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1676 */
1677static int nfs_volume_list_open(struct inode *inode, struct file *file)
1678{
1679	struct seq_file *m;
1680	int ret;
1681
1682	ret = seq_open(file, &nfs_volume_list_ops);
1683	if (ret < 0)
1684		return ret;
1685
1686	m = file->private_data;
1687	m->private = PDE(inode)->data;
1688
1689	return 0;
1690}
1691
1692/*
1693 * set up the iterator to start reading from the volume list and return the first item
1694 */
1695static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1696{
1697	/* lock the list against modification */
1698	spin_lock(&nfs_client_lock);
1699	return seq_list_start_head(&nfs_volume_list, *_pos);
1700}
1701
1702/*
1703 * move to next volume
1704 */
1705static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1706{
1707	return seq_list_next(v, &nfs_volume_list, pos);
1708}
1709
1710/*
1711 * clean up after reading from the transports list
1712 */
1713static void nfs_volume_list_stop(struct seq_file *p, void *v)
1714{
1715	spin_unlock(&nfs_client_lock);
1716}
1717
1718/*
1719 * display a header line followed by a load of call lines
1720 */
1721static int nfs_volume_list_show(struct seq_file *m, void *v)
1722{
1723	struct nfs_server *server;
1724	struct nfs_client *clp;
1725	char dev[8], fsid[17];
1726
1727	/* display header on line 1 */
1728	if (v == &nfs_volume_list) {
1729		seq_puts(m, "NV SERVER   PORT DEV     FSID              FSC\n");
1730		return 0;
1731	}
1732	/* display one transport per line on subsequent lines */
1733	server = list_entry(v, struct nfs_server, master_link);
1734	clp = server->nfs_client;
1735
1736	snprintf(dev, 8, "%u:%u",
1737		 MAJOR(server->s_dev), MINOR(server->s_dev));
1738
1739	snprintf(fsid, 17, "%llx:%llx",
1740		 (unsigned long long) server->fsid.major,
1741		 (unsigned long long) server->fsid.minor);
1742
1743	seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
1744		   clp->rpc_ops->version,
1745		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1746		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1747		   dev,
1748		   fsid,
1749		   nfs_server_fscache_state(server));
1750
1751	return 0;
1752}
1753
1754/*
1755 * initialise the /proc/fs/nfsfs/ directory
1756 */
1757int __init nfs_fs_proc_init(void)
1758{
1759	struct proc_dir_entry *p;
1760
1761	proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1762	if (!proc_fs_nfs)
1763		goto error_0;
1764
1765	/* a file of servers with which we're dealing */
1766	p = proc_create("servers", S_IFREG|S_IRUGO,
1767			proc_fs_nfs, &nfs_server_list_fops);
1768	if (!p)
1769		goto error_1;
1770
1771	/* a file of volumes that we have mounted */
1772	p = proc_create("volumes", S_IFREG|S_IRUGO,
1773			proc_fs_nfs, &nfs_volume_list_fops);
1774	if (!p)
1775		goto error_2;
1776	return 0;
1777
1778error_2:
1779	remove_proc_entry("servers", proc_fs_nfs);
1780error_1:
1781	remove_proc_entry("fs/nfsfs", NULL);
1782error_0:
1783	return -ENOMEM;
1784}
1785
1786/*
1787 * clean up the /proc/fs/nfsfs/ directory
1788 */
1789void nfs_fs_proc_exit(void)
1790{
1791	remove_proc_entry("volumes", proc_fs_nfs);
1792	remove_proc_entry("servers", proc_fs_nfs);
1793	remove_proc_entry("fs/nfsfs", NULL);
1794}
1795
1796#endif /* CONFIG_PROC_FS */
1797