1 /* client.c: NFS client sharing and management code
3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
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>
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>
41 #include <linux/nfs_xdr.h>
42 #include <linux/sunrpc/bc_xprt.h>
43 #include <linux/nsproxy.h>
44 #include <linux/pid_namespace.h>
49 #include "delegation.h"
56 #define NFSDBG_FACILITY NFSDBG_CLIENT
58 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
62 * Get a unique NFSv4.0 callback identifier which will be used
63 * by the V4.0 callback service to lookup the nfs_client struct
65 static int nfs_get_cb_ident_idr(struct nfs_client *clp, int minorversion)
68 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
70 if (clp->rpc_ops->version != 4 || minorversion != 0)
73 if (!idr_pre_get(&nn->cb_ident_idr, GFP_KERNEL))
75 spin_lock(&nn->nfs_client_lock);
76 ret = idr_get_new(&nn->cb_ident_idr, clp, &clp->cl_cb_ident);
77 spin_unlock(&nn->nfs_client_lock);
82 #endif /* CONFIG_NFS_V4 */
85 * Turn off NFSv4 uid/gid mapping when using AUTH_SYS
87 static bool nfs4_disable_idmapping = true;
92 static const struct rpc_version *nfs_version[5] = {
104 const struct rpc_program nfs_program = {
106 .number = NFS_PROGRAM,
107 .nrvers = ARRAY_SIZE(nfs_version),
108 .version = nfs_version,
109 .stats = &nfs_rpcstat,
110 .pipe_dir_name = NFS_PIPE_DIRNAME,
113 struct rpc_stat nfs_rpcstat = {
114 .program = &nfs_program
118 #ifdef CONFIG_NFS_V3_ACL
119 static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
120 static const struct rpc_version *nfsacl_version[] = {
121 [3] = &nfsacl_version3,
124 const struct rpc_program nfsacl_program = {
126 .number = NFS_ACL_PROGRAM,
127 .nrvers = ARRAY_SIZE(nfsacl_version),
128 .version = nfsacl_version,
129 .stats = &nfsacl_rpcstat,
131 #endif /* CONFIG_NFS_V3_ACL */
133 struct nfs_client_initdata {
134 unsigned long init_flags;
135 const char *hostname;
136 const struct sockaddr *addr;
138 const struct nfs_rpc_ops *rpc_ops;
145 * Allocate a shared client record
147 * Since these are allocated/deallocated very rarely, we don't
148 * bother putting them in a slab cache...
150 static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
152 struct nfs_client *clp;
153 struct rpc_cred *cred;
156 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
159 clp->rpc_ops = cl_init->rpc_ops;
161 atomic_set(&clp->cl_count, 1);
162 clp->cl_cons_state = NFS_CS_INITING;
164 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
165 clp->cl_addrlen = cl_init->addrlen;
167 if (cl_init->hostname) {
169 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
170 if (!clp->cl_hostname)
174 INIT_LIST_HEAD(&clp->cl_superblocks);
175 clp->cl_rpcclient = ERR_PTR(-EINVAL);
177 clp->cl_proto = cl_init->proto;
178 clp->cl_net = get_net(cl_init->net);
181 err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
185 spin_lock_init(&clp->cl_lock);
186 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
187 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
188 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
189 clp->cl_minorversion = cl_init->minorversion;
190 clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
192 cred = rpc_lookup_machine_cred("*");
194 clp->cl_machine_cred = cred;
195 nfs_fscache_get_client_cookie(clp);
206 #ifdef CONFIG_NFS_V4_1
207 static void nfs4_shutdown_session(struct nfs_client *clp)
209 if (nfs4_has_session(clp)) {
210 nfs4_deviceid_purge_client(clp);
211 nfs4_destroy_session(clp->cl_session);
212 nfs4_destroy_clientid(clp);
216 #else /* CONFIG_NFS_V4_1 */
217 static void nfs4_shutdown_session(struct nfs_client *clp)
220 #endif /* CONFIG_NFS_V4_1 */
223 * Destroy the NFS4 callback service
225 static void nfs4_destroy_callback(struct nfs_client *clp)
227 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
228 nfs_callback_down(clp->cl_mvops->minor_version);
231 static void nfs4_shutdown_client(struct nfs_client *clp)
233 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
234 nfs4_kill_renewd(clp);
235 nfs4_shutdown_session(clp);
236 nfs4_destroy_callback(clp);
237 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
238 nfs_idmap_delete(clp);
240 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
241 kfree(clp->cl_serverowner);
242 kfree(clp->cl_serverscope);
243 kfree(clp->cl_implid);
246 /* idr_remove_all is not needed as all id's are removed by nfs_put_client */
247 void nfs_cleanup_cb_ident_idr(struct net *net)
249 struct nfs_net *nn = net_generic(net, nfs_net_id);
251 idr_destroy(&nn->cb_ident_idr);
254 /* nfs_client_lock held */
255 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
257 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
259 if (clp->cl_cb_ident)
260 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
263 static void pnfs_init_server(struct nfs_server *server)
265 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
268 static void nfs4_destroy_server(struct nfs_server *server)
270 nfs4_purge_state_owners(server);
274 static void nfs4_shutdown_client(struct nfs_client *clp)
278 void nfs_cleanup_cb_ident_idr(struct net *net)
282 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
286 static void pnfs_init_server(struct nfs_server *server)
290 #endif /* CONFIG_NFS_V4 */
293 * Destroy a shared client record
295 static void nfs_free_client(struct nfs_client *clp)
297 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
299 nfs4_shutdown_client(clp);
301 nfs_fscache_release_client_cookie(clp);
303 /* -EIO all pending I/O */
304 if (!IS_ERR(clp->cl_rpcclient))
305 rpc_shutdown_client(clp->cl_rpcclient);
307 if (clp->cl_machine_cred != NULL)
308 put_rpccred(clp->cl_machine_cred);
310 put_net(clp->cl_net);
311 kfree(clp->cl_hostname);
314 dprintk("<-- nfs_free_client()\n");
318 * Release a reference to a shared client record
320 void nfs_put_client(struct nfs_client *clp)
327 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
328 nn = net_generic(clp->cl_net, nfs_net_id);
330 if (atomic_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
331 list_del(&clp->cl_share_link);
332 nfs_cb_idr_remove_locked(clp);
333 spin_unlock(&nn->nfs_client_lock);
335 BUG_ON(!list_empty(&clp->cl_superblocks));
337 nfs_free_client(clp);
340 EXPORT_SYMBOL_GPL(nfs_put_client);
342 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
344 * Test if two ip6 socket addresses refer to the same socket by
345 * comparing relevant fields. The padding bytes specifically, are not
346 * compared. sin6_flowinfo is not compared because it only affects QoS
347 * and sin6_scope_id is only compared if the address is "link local"
348 * because "link local" addresses need only be unique to a specific
349 * link. Conversely, ordinary unicast addresses might have different
352 * The caller should ensure both socket addresses are AF_INET6.
354 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
355 const struct sockaddr *sa2)
357 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
358 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
360 if (!ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr))
362 else if (ipv6_addr_type(&sin1->sin6_addr) & IPV6_ADDR_LINKLOCAL)
363 return sin1->sin6_scope_id == sin2->sin6_scope_id;
367 #else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
368 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
369 const struct sockaddr *sa2)
376 * Test if two ip4 socket addresses refer to the same socket, by
377 * comparing relevant fields. The padding bytes specifically, are
380 * The caller should ensure both socket addresses are AF_INET.
382 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr *sa1,
383 const struct sockaddr *sa2)
385 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
386 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
388 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
391 static int nfs_sockaddr_cmp_ip6(const struct sockaddr *sa1,
392 const struct sockaddr *sa2)
394 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
395 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
397 return nfs_sockaddr_match_ipaddr6(sa1, sa2) &&
398 (sin1->sin6_port == sin2->sin6_port);
401 static int nfs_sockaddr_cmp_ip4(const struct sockaddr *sa1,
402 const struct sockaddr *sa2)
404 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
405 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
407 return nfs_sockaddr_match_ipaddr4(sa1, sa2) &&
408 (sin1->sin_port == sin2->sin_port);
411 #if defined(CONFIG_NFS_V4_1)
413 * Test if two socket addresses represent the same actual socket,
414 * by comparing (only) relevant fields, excluding the port number.
416 static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
417 const struct sockaddr *sa2)
419 if (sa1->sa_family != sa2->sa_family)
422 switch (sa1->sa_family) {
424 return nfs_sockaddr_match_ipaddr4(sa1, sa2);
426 return nfs_sockaddr_match_ipaddr6(sa1, sa2);
430 #endif /* CONFIG_NFS_V4_1 */
433 * Test if two socket addresses represent the same actual socket,
434 * by comparing (only) relevant fields, including the port number.
436 static int nfs_sockaddr_cmp(const struct sockaddr *sa1,
437 const struct sockaddr *sa2)
439 if (sa1->sa_family != sa2->sa_family)
442 switch (sa1->sa_family) {
444 return nfs_sockaddr_cmp_ip4(sa1, sa2);
446 return nfs_sockaddr_cmp_ip6(sa1, sa2);
451 #if defined(CONFIG_NFS_V4_1)
452 /* Common match routine for v4.0 and v4.1 callback services */
453 static bool nfs4_cb_match_client(const struct sockaddr *addr,
454 struct nfs_client *clp, u32 minorversion)
456 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
458 /* Don't match clients that failed to initialise */
459 if (!(clp->cl_cons_state == NFS_CS_READY ||
460 clp->cl_cons_state == NFS_CS_SESSION_INITING))
465 /* Match the version and minorversion */
466 if (clp->rpc_ops->version != 4 ||
467 clp->cl_minorversion != minorversion)
470 /* Match only the IP address, not the port number */
471 if (!nfs_sockaddr_match_ipaddr(addr, clap))
476 #endif /* CONFIG_NFS_V4_1 */
479 * Find an nfs_client on the list that matches the initialisation data
482 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
484 struct nfs_client *clp;
485 const struct sockaddr *sap = data->addr;
486 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
488 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
489 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
490 /* Don't match clients that failed to initialise properly */
491 if (clp->cl_cons_state < 0)
494 /* Different NFS versions cannot share the same nfs_client */
495 if (clp->rpc_ops != data->rpc_ops)
498 if (clp->cl_proto != data->proto)
500 /* Match nfsv4 minorversion */
501 if (clp->cl_minorversion != data->minorversion)
503 /* Match the full socket address */
504 if (!nfs_sockaddr_cmp(sap, clap))
507 atomic_inc(&clp->cl_count);
513 static bool nfs_client_init_is_complete(const struct nfs_client *clp)
515 return clp->cl_cons_state != NFS_CS_INITING;
518 int nfs_wait_client_init_complete(const struct nfs_client *clp)
520 return wait_event_killable(nfs_client_active_wq,
521 nfs_client_init_is_complete(clp));
525 * Found an existing client. Make sure it's ready before returning.
527 static struct nfs_client *
528 nfs_found_client(const struct nfs_client_initdata *cl_init,
529 struct nfs_client *clp)
533 error = nfs_wait_client_init_complete(clp);
536 return ERR_PTR(-ERESTARTSYS);
539 if (clp->cl_cons_state < NFS_CS_READY) {
540 error = clp->cl_cons_state;
542 return ERR_PTR(error);
547 dprintk("<-- %s found nfs_client %p for %s\n",
548 __func__, clp, cl_init->hostname ?: "");
553 * Look up a client by IP address and protocol version
554 * - creates a new record if one doesn't yet exist
556 static struct nfs_client *
557 nfs_get_client(const struct nfs_client_initdata *cl_init,
558 const struct rpc_timeout *timeparms,
560 rpc_authflavor_t authflavour)
562 struct nfs_client *clp, *new = NULL;
563 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
565 dprintk("--> nfs_get_client(%s,v%u)\n",
566 cl_init->hostname ?: "", cl_init->rpc_ops->version);
568 /* see if the client already exists */
570 spin_lock(&nn->nfs_client_lock);
572 clp = nfs_match_client(cl_init);
574 spin_unlock(&nn->nfs_client_lock);
576 nfs_free_client(new);
577 return nfs_found_client(cl_init, clp);
580 list_add(&new->cl_share_link, &nn->nfs_client_list);
581 spin_unlock(&nn->nfs_client_lock);
582 new->cl_flags = cl_init->init_flags;
583 return cl_init->rpc_ops->init_client(new,
588 spin_unlock(&nn->nfs_client_lock);
590 new = nfs_alloc_client(cl_init);
591 } while (!IS_ERR(new));
593 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
594 cl_init->hostname ?: "", PTR_ERR(new));
599 * Mark a server as ready or failed
601 void nfs_mark_client_ready(struct nfs_client *clp, int state)
604 clp->cl_cons_state = state;
605 wake_up_all(&nfs_client_active_wq);
609 * Initialise the timeout values for a connection
611 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
612 unsigned int timeo, unsigned int retrans)
614 to->to_initval = timeo * HZ / 10;
615 to->to_retries = retrans;
618 case XPRT_TRANSPORT_TCP:
619 case XPRT_TRANSPORT_RDMA:
620 if (to->to_retries == 0)
621 to->to_retries = NFS_DEF_TCP_RETRANS;
622 if (to->to_initval == 0)
623 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
624 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
625 to->to_initval = NFS_MAX_TCP_TIMEOUT;
626 to->to_increment = to->to_initval;
627 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
628 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
629 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
630 if (to->to_maxval < to->to_initval)
631 to->to_maxval = to->to_initval;
632 to->to_exponential = 0;
634 case XPRT_TRANSPORT_UDP:
635 if (to->to_retries == 0)
636 to->to_retries = NFS_DEF_UDP_RETRANS;
638 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
639 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
640 to->to_initval = NFS_MAX_UDP_TIMEOUT;
641 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
642 to->to_exponential = 1;
650 * Create an RPC client handle
652 static int nfs_create_rpc_client(struct nfs_client *clp,
653 const struct rpc_timeout *timeparms,
654 rpc_authflavor_t flavor)
656 struct rpc_clnt *clnt = NULL;
657 struct rpc_create_args args = {
659 .protocol = clp->cl_proto,
660 .address = (struct sockaddr *)&clp->cl_addr,
661 .addrsize = clp->cl_addrlen,
662 .timeout = timeparms,
663 .servername = clp->cl_hostname,
664 .program = &nfs_program,
665 .version = clp->rpc_ops->version,
666 .authflavor = flavor,
669 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
670 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
671 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
672 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
674 if (!IS_ERR(clp->cl_rpcclient))
677 clnt = rpc_create(&args);
679 dprintk("%s: cannot create RPC client. Error = %ld\n",
680 __func__, PTR_ERR(clnt));
681 return PTR_ERR(clnt);
684 clp->cl_rpcclient = clnt;
689 * Version 2 or 3 client destruction
691 static void nfs_destroy_server(struct nfs_server *server)
693 if (!(server->flags & NFS_MOUNT_LOCAL_FLOCK) ||
694 !(server->flags & NFS_MOUNT_LOCAL_FCNTL))
695 nlmclnt_done(server->nlm_host);
699 * Version 2 or 3 lockd setup
701 static int nfs_start_lockd(struct nfs_server *server)
703 struct nlm_host *host;
704 struct nfs_client *clp = server->nfs_client;
705 struct nlmclnt_initdata nlm_init = {
706 .hostname = clp->cl_hostname,
707 .address = (struct sockaddr *)&clp->cl_addr,
708 .addrlen = clp->cl_addrlen,
709 .nfs_version = clp->rpc_ops->version,
710 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
715 if (nlm_init.nfs_version > 3)
717 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
718 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
721 switch (clp->cl_proto) {
723 nlm_init.protocol = IPPROTO_TCP;
725 case XPRT_TRANSPORT_UDP:
726 nlm_init.protocol = IPPROTO_UDP;
729 host = nlmclnt_init(&nlm_init);
731 return PTR_ERR(host);
733 server->nlm_host = host;
734 server->destroy = nfs_destroy_server;
739 * Initialise an NFSv3 ACL client connection
741 #ifdef CONFIG_NFS_V3_ACL
742 static void nfs_init_server_aclclient(struct nfs_server *server)
744 if (server->nfs_client->rpc_ops->version != 3)
746 if (server->flags & NFS_MOUNT_NOACL)
749 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
750 if (IS_ERR(server->client_acl))
753 /* No errors! Assume that Sun nfsacls are supported */
754 server->caps |= NFS_CAP_ACLS;
758 server->caps &= ~NFS_CAP_ACLS;
761 static inline void nfs_init_server_aclclient(struct nfs_server *server)
763 server->flags &= ~NFS_MOUNT_NOACL;
764 server->caps &= ~NFS_CAP_ACLS;
769 * Create a general RPC client
771 static int nfs_init_server_rpcclient(struct nfs_server *server,
772 const struct rpc_timeout *timeo,
773 rpc_authflavor_t pseudoflavour)
775 struct nfs_client *clp = server->nfs_client;
777 server->client = rpc_clone_client(clp->cl_rpcclient);
778 if (IS_ERR(server->client)) {
779 dprintk("%s: couldn't create rpc_client!\n", __func__);
780 return PTR_ERR(server->client);
783 memcpy(&server->client->cl_timeout_default,
785 sizeof(server->client->cl_timeout_default));
786 server->client->cl_timeout = &server->client->cl_timeout_default;
788 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
789 struct rpc_auth *auth;
791 auth = rpcauth_create(pseudoflavour, server->client);
793 dprintk("%s: couldn't create credcache!\n", __func__);
794 return PTR_ERR(auth);
797 server->client->cl_softrtry = 0;
798 if (server->flags & NFS_MOUNT_SOFT)
799 server->client->cl_softrtry = 1;
805 * nfs_init_client - Initialise an NFS2 or NFS3 client
807 * @clp: nfs_client to initialise
808 * @timeparms: timeout parameters for underlying RPC transport
809 * @ip_addr: IP presentation address (not used)
810 * @authflavor: authentication flavor for underlying RPC transport
812 * Returns pointer to an NFS client, or an ERR_PTR value.
814 struct nfs_client *nfs_init_client(struct nfs_client *clp,
815 const struct rpc_timeout *timeparms,
816 const char *ip_addr, rpc_authflavor_t authflavour)
820 if (clp->cl_cons_state == NFS_CS_READY) {
821 /* the client is already initialised */
822 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
827 * Create a client RPC handle for doing FSSTAT with UNIX auth only
828 * - RFC 2623, sec 2.3.2
830 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX);
833 nfs_mark_client_ready(clp, NFS_CS_READY);
837 nfs_mark_client_ready(clp, error);
839 dprintk("<-- nfs_init_client() = xerror %d\n", error);
840 return ERR_PTR(error);
844 * Create a version 2 or 3 client
846 static int nfs_init_server(struct nfs_server *server,
847 const struct nfs_parsed_mount_data *data)
849 struct nfs_client_initdata cl_init = {
850 .hostname = data->nfs_server.hostname,
851 .addr = (const struct sockaddr *)&data->nfs_server.address,
852 .addrlen = data->nfs_server.addrlen,
854 .proto = data->nfs_server.protocol,
857 struct rpc_timeout timeparms;
858 struct nfs_client *clp;
861 dprintk("--> nfs_init_server()\n");
863 switch (data->version) {
866 cl_init.rpc_ops = &nfs_v2_clientops;
871 cl_init.rpc_ops = &nfs_v3_clientops;
875 return -EPROTONOSUPPORT;
878 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
879 data->timeo, data->retrans);
880 if (data->flags & NFS_MOUNT_NORESVPORT)
881 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
883 /* Allocate or find a client reference we can use */
884 clp = nfs_get_client(&cl_init, &timeparms, NULL, RPC_AUTH_UNIX);
886 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
890 server->nfs_client = clp;
892 /* Initialise the client representation from the mount data */
893 server->flags = data->flags;
894 server->options = data->options;
895 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
896 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
897 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME|NFS_CAP_CHANGE_ATTR;
900 server->rsize = nfs_block_size(data->rsize, NULL);
902 server->wsize = nfs_block_size(data->wsize, NULL);
904 server->acregmin = data->acregmin * HZ;
905 server->acregmax = data->acregmax * HZ;
906 server->acdirmin = data->acdirmin * HZ;
907 server->acdirmax = data->acdirmax * HZ;
909 /* Start lockd here, before we might error out */
910 error = nfs_start_lockd(server);
914 server->port = data->nfs_server.port;
916 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
920 /* Preserve the values of mount_server-related mount options */
921 if (data->mount_server.addrlen) {
922 memcpy(&server->mountd_address, &data->mount_server.address,
923 data->mount_server.addrlen);
924 server->mountd_addrlen = data->mount_server.addrlen;
926 server->mountd_version = data->mount_server.version;
927 server->mountd_port = data->mount_server.port;
928 server->mountd_protocol = data->mount_server.protocol;
930 server->namelen = data->namlen;
931 /* Create a client RPC handle for the NFSv3 ACL management interface */
932 nfs_init_server_aclclient(server);
933 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
937 server->nfs_client = NULL;
939 dprintk("<-- nfs_init_server() = xerror %d\n", error);
944 * Load up the server record from information gained in an fsinfo record
946 static void nfs_server_set_fsinfo(struct nfs_server *server,
947 struct nfs_fh *mntfh,
948 struct nfs_fsinfo *fsinfo)
950 unsigned long max_rpc_payload;
952 /* Work out a lot of parameters */
953 if (server->rsize == 0)
954 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
955 if (server->wsize == 0)
956 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
958 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
959 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
960 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
961 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
963 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
964 if (server->rsize > max_rpc_payload)
965 server->rsize = max_rpc_payload;
966 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
967 server->rsize = NFS_MAX_FILE_IO_SIZE;
968 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
970 server->backing_dev_info.name = "nfs";
971 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
973 if (server->wsize > max_rpc_payload)
974 server->wsize = max_rpc_payload;
975 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
976 server->wsize = NFS_MAX_FILE_IO_SIZE;
977 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
978 server->pnfs_blksize = fsinfo->blksize;
979 set_pnfs_layoutdriver(server, mntfh, fsinfo->layouttype);
981 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
983 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
984 if (server->dtsize > PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES)
985 server->dtsize = PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES;
986 if (server->dtsize > server->rsize)
987 server->dtsize = server->rsize;
989 if (server->flags & NFS_MOUNT_NOAC) {
990 server->acregmin = server->acregmax = 0;
991 server->acdirmin = server->acdirmax = 0;
994 server->maxfilesize = fsinfo->maxfilesize;
996 server->time_delta = fsinfo->time_delta;
998 /* We're airborne Set socket buffersize */
999 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
1003 * Probe filesystem information, including the FSID on v2/v3
1005 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
1007 struct nfs_fsinfo fsinfo;
1008 struct nfs_client *clp = server->nfs_client;
1011 dprintk("--> nfs_probe_fsinfo()\n");
1013 if (clp->rpc_ops->set_capabilities != NULL) {
1014 error = clp->rpc_ops->set_capabilities(server, mntfh);
1019 fsinfo.fattr = fattr;
1020 fsinfo.layouttype = 0;
1021 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
1025 nfs_server_set_fsinfo(server, mntfh, &fsinfo);
1027 /* Get some general file system info */
1028 if (server->namelen == 0) {
1029 struct nfs_pathconf pathinfo;
1031 pathinfo.fattr = fattr;
1032 nfs_fattr_init(fattr);
1034 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
1035 server->namelen = pathinfo.max_namelen;
1038 dprintk("<-- nfs_probe_fsinfo() = 0\n");
1042 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
1047 * Copy useful information when duplicating a server record
1049 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
1051 target->flags = source->flags;
1052 target->rsize = source->rsize;
1053 target->wsize = source->wsize;
1054 target->acregmin = source->acregmin;
1055 target->acregmax = source->acregmax;
1056 target->acdirmin = source->acdirmin;
1057 target->acdirmax = source->acdirmax;
1058 target->caps = source->caps;
1059 target->options = source->options;
1062 static void nfs_server_insert_lists(struct nfs_server *server)
1064 struct nfs_client *clp = server->nfs_client;
1065 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
1067 spin_lock(&nn->nfs_client_lock);
1068 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
1069 list_add_tail(&server->master_link, &nn->nfs_volume_list);
1070 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
1071 spin_unlock(&nn->nfs_client_lock);
1075 static void nfs_server_remove_lists(struct nfs_server *server)
1077 struct nfs_client *clp = server->nfs_client;
1082 nn = net_generic(clp->cl_net, nfs_net_id);
1083 spin_lock(&nn->nfs_client_lock);
1084 list_del_rcu(&server->client_link);
1085 if (list_empty(&clp->cl_superblocks))
1086 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
1087 list_del(&server->master_link);
1088 spin_unlock(&nn->nfs_client_lock);
1094 * Allocate and initialise a server record
1096 static struct nfs_server *nfs_alloc_server(void)
1098 struct nfs_server *server;
1100 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
1104 server->client = server->client_acl = ERR_PTR(-EINVAL);
1106 /* Zero out the NFS state stuff */
1107 INIT_LIST_HEAD(&server->client_link);
1108 INIT_LIST_HEAD(&server->master_link);
1109 INIT_LIST_HEAD(&server->delegations);
1110 INIT_LIST_HEAD(&server->layouts);
1111 INIT_LIST_HEAD(&server->state_owners_lru);
1113 atomic_set(&server->active, 0);
1115 server->io_stats = nfs_alloc_iostats();
1116 if (!server->io_stats) {
1121 if (bdi_init(&server->backing_dev_info)) {
1122 nfs_free_iostats(server->io_stats);
1127 ida_init(&server->openowner_id);
1128 ida_init(&server->lockowner_id);
1129 pnfs_init_server(server);
1135 * Free up a server record
1137 void nfs_free_server(struct nfs_server *server)
1139 dprintk("--> nfs_free_server()\n");
1141 nfs_server_remove_lists(server);
1142 unset_pnfs_layoutdriver(server);
1144 if (server->destroy != NULL)
1145 server->destroy(server);
1147 if (!IS_ERR(server->client_acl))
1148 rpc_shutdown_client(server->client_acl);
1149 if (!IS_ERR(server->client))
1150 rpc_shutdown_client(server->client);
1152 nfs_put_client(server->nfs_client);
1154 ida_destroy(&server->lockowner_id);
1155 ida_destroy(&server->openowner_id);
1156 nfs_free_iostats(server->io_stats);
1157 bdi_destroy(&server->backing_dev_info);
1159 nfs_release_automount_timer();
1160 dprintk("<-- nfs_free_server()\n");
1164 * Create a version 2 or 3 volume record
1165 * - keyed on server and FSID
1167 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
1168 struct nfs_fh *mntfh)
1170 struct nfs_server *server;
1171 struct nfs_fattr *fattr;
1174 server = nfs_alloc_server();
1176 return ERR_PTR(-ENOMEM);
1179 fattr = nfs_alloc_fattr();
1183 /* Get a client representation */
1184 error = nfs_init_server(server, data);
1188 BUG_ON(!server->nfs_client);
1189 BUG_ON(!server->nfs_client->rpc_ops);
1190 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1192 /* Probe the root fh to retrieve its FSID */
1193 error = nfs_probe_fsinfo(server, mntfh, fattr);
1196 if (server->nfs_client->rpc_ops->version == 3) {
1197 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1198 server->namelen = NFS3_MAXNAMLEN;
1199 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
1200 server->caps |= NFS_CAP_READDIRPLUS;
1202 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1203 server->namelen = NFS2_MAXNAMLEN;
1206 if (!(fattr->valid & NFS_ATTR_FATTR)) {
1207 error = server->nfs_client->rpc_ops->getattr(server, mntfh, fattr);
1209 dprintk("nfs_create_server: getattr error = %d\n", -error);
1213 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1215 dprintk("Server FSID: %llx:%llx\n",
1216 (unsigned long long) server->fsid.major,
1217 (unsigned long long) server->fsid.minor);
1219 nfs_server_insert_lists(server);
1220 server->mount_time = jiffies;
1221 nfs_free_fattr(fattr);
1225 nfs_free_fattr(fattr);
1226 nfs_free_server(server);
1227 return ERR_PTR(error);
1230 #ifdef CONFIG_NFS_V4
1232 * NFSv4.0 callback thread helper
1234 * Find a client by callback identifier
1237 nfs4_find_client_ident(struct net *net, int cb_ident)
1239 struct nfs_client *clp;
1240 struct nfs_net *nn = net_generic(net, nfs_net_id);
1242 spin_lock(&nn->nfs_client_lock);
1243 clp = idr_find(&nn->cb_ident_idr, cb_ident);
1245 atomic_inc(&clp->cl_count);
1246 spin_unlock(&nn->nfs_client_lock);
1250 #if defined(CONFIG_NFS_V4_1)
1252 * NFSv4.1 callback thread helper
1253 * For CB_COMPOUND calls, find a client by IP address, protocol version,
1254 * minorversion, and sessionID
1256 * Returns NULL if no such client
1259 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
1260 struct nfs4_sessionid *sid)
1262 struct nfs_client *clp;
1263 struct nfs_net *nn = net_generic(net, nfs_net_id);
1265 spin_lock(&nn->nfs_client_lock);
1266 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
1267 if (nfs4_cb_match_client(addr, clp, 1) == false)
1270 if (!nfs4_has_session(clp))
1273 /* Match sessionid*/
1274 if (memcmp(clp->cl_session->sess_id.data,
1275 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
1278 atomic_inc(&clp->cl_count);
1279 spin_unlock(&nn->nfs_client_lock);
1282 spin_unlock(&nn->nfs_client_lock);
1286 #else /* CONFIG_NFS_V4_1 */
1289 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
1290 struct nfs4_sessionid *sid)
1294 #endif /* CONFIG_NFS_V4_1 */
1297 * Initialize the NFS4 callback service
1299 static int nfs4_init_callback(struct nfs_client *clp)
1303 if (clp->rpc_ops->version == 4) {
1304 struct rpc_xprt *xprt;
1306 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
1308 if (nfs4_has_session(clp)) {
1309 error = xprt_setup_backchannel(xprt,
1310 NFS41_BC_MIN_CALLBACKS);
1315 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
1317 dprintk("%s: failed to start callback. Error = %d\n",
1321 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
1327 * Initialize the minor version specific parts of an NFS4 client record
1329 static int nfs4_init_client_minor_version(struct nfs_client *clp)
1331 #if defined(CONFIG_NFS_V4_1)
1332 if (clp->cl_mvops->minor_version) {
1333 struct nfs4_session *session = NULL;
1335 * Create the session and mark it expired.
1336 * When a SEQUENCE operation encounters the expired session
1337 * it will do session recovery to initialize it.
1339 session = nfs4_alloc_session(clp);
1343 clp->cl_session = session;
1345 * The create session reply races with the server back
1346 * channel probe. Mark the client NFS_CS_SESSION_INITING
1347 * so that the client back channel can find the
1350 nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
1352 #endif /* CONFIG_NFS_V4_1 */
1354 return nfs4_init_callback(clp);
1358 * nfs4_init_client - Initialise an NFS4 client record
1360 * @clp: nfs_client to initialise
1361 * @timeparms: timeout parameters for underlying RPC transport
1362 * @ip_addr: callback IP address in presentation format
1363 * @authflavor: authentication flavor for underlying RPC transport
1365 * Returns pointer to an NFS client, or an ERR_PTR value.
1367 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
1368 const struct rpc_timeout *timeparms,
1369 const char *ip_addr,
1370 rpc_authflavor_t authflavour)
1372 char buf[INET6_ADDRSTRLEN + 1];
1375 if (clp->cl_cons_state == NFS_CS_READY) {
1376 /* the client is initialised already */
1377 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
1381 /* Check NFS protocol revision and initialize RPC op vector */
1382 clp->rpc_ops = &nfs_v4_clientops;
1384 __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
1385 error = nfs_create_rpc_client(clp, timeparms, authflavour);
1389 /* If no clientaddr= option was specified, find a usable cb address */
1390 if (ip_addr == NULL) {
1391 struct sockaddr_storage cb_addr;
1392 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
1394 error = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
1397 error = rpc_ntop(sap, buf, sizeof(buf));
1400 ip_addr = (const char *)buf;
1402 strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
1404 error = nfs_idmap_new(clp);
1406 dprintk("%s: failed to create idmapper. Error = %d\n",
1410 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
1412 error = nfs4_init_client_minor_version(clp);
1416 if (!nfs4_has_session(clp))
1417 nfs_mark_client_ready(clp, NFS_CS_READY);
1421 nfs_mark_client_ready(clp, error);
1422 nfs_put_client(clp);
1423 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
1424 return ERR_PTR(error);
1428 * Set up an NFS4 client
1430 static int nfs4_set_client(struct nfs_server *server,
1431 const char *hostname,
1432 const struct sockaddr *addr,
1433 const size_t addrlen,
1434 const char *ip_addr,
1435 rpc_authflavor_t authflavour,
1436 int proto, const struct rpc_timeout *timeparms,
1437 u32 minorversion, struct net *net)
1439 struct nfs_client_initdata cl_init = {
1440 .hostname = hostname,
1443 .rpc_ops = &nfs_v4_clientops,
1445 .minorversion = minorversion,
1448 struct nfs_client *clp;
1451 dprintk("--> nfs4_set_client()\n");
1453 if (server->flags & NFS_MOUNT_NORESVPORT)
1454 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
1456 /* Allocate or find a client reference we can use */
1457 clp = nfs_get_client(&cl_init, timeparms, ip_addr, authflavour);
1459 error = PTR_ERR(clp);
1464 * Query for the lease time on clientid setup or renewal
1466 * Note that this will be set on nfs_clients that were created
1467 * only for the DS role and did not set this bit, but now will
1468 * serve a dual role.
1470 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
1472 server->nfs_client = clp;
1473 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
1476 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
1481 * Set up a pNFS Data Server client.
1483 * Return any existing nfs_client that matches server address,port,version
1486 * For a new nfs_client, use a soft mount (default), a low retrans and a
1487 * low timeout interval so that if a connection is lost, we retry through
1490 struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
1491 const struct sockaddr *ds_addr, int ds_addrlen,
1492 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans)
1494 struct nfs_client_initdata cl_init = {
1496 .addrlen = ds_addrlen,
1497 .rpc_ops = &nfs_v4_clientops,
1499 .minorversion = mds_clp->cl_minorversion,
1500 .net = mds_clp->cl_net,
1502 struct rpc_timeout ds_timeout;
1503 struct nfs_client *clp;
1506 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
1507 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
1508 * (section 13.1 RFC 5661).
1510 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
1511 clp = nfs_get_client(&cl_init, &ds_timeout, mds_clp->cl_ipaddr,
1512 mds_clp->cl_rpcclient->cl_auth->au_flavor);
1514 dprintk("<-- %s %p\n", __func__, clp);
1517 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
1520 * Session has been established, and the client marked ready.
1521 * Set the mount rsize and wsize with negotiated fore channel
1522 * attributes which will be bound checked in nfs_server_set_fsinfo.
1524 static void nfs4_session_set_rwsize(struct nfs_server *server)
1526 #ifdef CONFIG_NFS_V4_1
1527 struct nfs4_session *sess;
1531 if (!nfs4_has_session(server->nfs_client))
1533 sess = server->nfs_client->cl_session;
1534 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1535 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1537 if (server->rsize > server_resp_sz)
1538 server->rsize = server_resp_sz;
1539 if (server->wsize > server_rqst_sz)
1540 server->wsize = server_rqst_sz;
1541 #endif /* CONFIG_NFS_V4_1 */
1544 static int nfs4_server_common_setup(struct nfs_server *server,
1545 struct nfs_fh *mntfh)
1547 struct nfs_fattr *fattr;
1550 BUG_ON(!server->nfs_client);
1551 BUG_ON(!server->nfs_client->rpc_ops);
1552 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1554 /* data servers support only a subset of NFSv4.1 */
1555 if (is_ds_only_client(server->nfs_client))
1556 return -EPROTONOSUPPORT;
1558 fattr = nfs_alloc_fattr();
1562 /* We must ensure the session is initialised first */
1563 error = nfs4_init_session(server);
1567 /* Probe the root fh to retrieve its FSID and filehandle */
1568 error = nfs4_get_rootfh(server, mntfh);
1572 dprintk("Server FSID: %llx:%llx\n",
1573 (unsigned long long) server->fsid.major,
1574 (unsigned long long) server->fsid.minor);
1575 dprintk("Mount FH: %d\n", mntfh->size);
1577 nfs4_session_set_rwsize(server);
1579 error = nfs_probe_fsinfo(server, mntfh, fattr);
1583 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1584 server->namelen = NFS4_MAXNAMLEN;
1586 nfs_server_insert_lists(server);
1587 server->mount_time = jiffies;
1588 server->destroy = nfs4_destroy_server;
1590 nfs_free_fattr(fattr);
1595 * Create a version 4 volume record
1597 static int nfs4_init_server(struct nfs_server *server,
1598 const struct nfs_parsed_mount_data *data)
1600 struct rpc_timeout timeparms;
1603 dprintk("--> nfs4_init_server()\n");
1605 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1606 data->timeo, data->retrans);
1608 /* Initialise the client representation from the mount data */
1609 server->flags = data->flags;
1610 server->caps |= NFS_CAP_ATOMIC_OPEN|NFS_CAP_CHANGE_ATTR|NFS_CAP_POSIX_LOCK;
1611 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
1612 server->caps |= NFS_CAP_READDIRPLUS;
1613 server->options = data->options;
1615 /* Get a client record */
1616 error = nfs4_set_client(server,
1617 data->nfs_server.hostname,
1618 (const struct sockaddr *)&data->nfs_server.address,
1619 data->nfs_server.addrlen,
1620 data->client_address,
1621 data->auth_flavors[0],
1622 data->nfs_server.protocol,
1630 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1633 if (nfs4_disable_idmapping && data->auth_flavors[0] == RPC_AUTH_UNIX)
1634 server->caps |= NFS_CAP_UIDGID_NOMAP;
1637 server->rsize = nfs_block_size(data->rsize, NULL);
1639 server->wsize = nfs_block_size(data->wsize, NULL);
1641 server->acregmin = data->acregmin * HZ;
1642 server->acregmax = data->acregmax * HZ;
1643 server->acdirmin = data->acdirmin * HZ;
1644 server->acdirmax = data->acdirmax * HZ;
1646 server->port = data->nfs_server.port;
1648 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1652 dprintk("<-- nfs4_init_server() = %d\n", error);
1657 * Create a version 4 volume record
1658 * - keyed on server and FSID
1660 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1661 struct nfs_fh *mntfh)
1663 struct nfs_server *server;
1666 dprintk("--> nfs4_create_server()\n");
1668 server = nfs_alloc_server();
1670 return ERR_PTR(-ENOMEM);
1672 /* set up the general RPC client */
1673 error = nfs4_init_server(server, data);
1677 error = nfs4_server_common_setup(server, mntfh);
1681 dprintk("<-- nfs4_create_server() = %p\n", server);
1685 nfs_free_server(server);
1686 dprintk("<-- nfs4_create_server() = error %d\n", error);
1687 return ERR_PTR(error);
1691 * Create an NFS4 referral server record
1693 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1694 struct nfs_fh *mntfh)
1696 struct nfs_client *parent_client;
1697 struct nfs_server *server, *parent_server;
1700 dprintk("--> nfs4_create_referral_server()\n");
1702 server = nfs_alloc_server();
1704 return ERR_PTR(-ENOMEM);
1706 parent_server = NFS_SB(data->sb);
1707 parent_client = parent_server->nfs_client;
1709 /* Initialise the client representation from the parent server */
1710 nfs_server_copy_userdata(server, parent_server);
1711 server->caps |= NFS_CAP_ATOMIC_OPEN|NFS_CAP_CHANGE_ATTR;
1713 /* Get a client representation.
1714 * Note: NFSv4 always uses TCP, */
1715 error = nfs4_set_client(server, data->hostname,
1718 parent_client->cl_ipaddr,
1720 rpc_protocol(parent_server->client),
1721 parent_server->client->cl_timeout,
1722 parent_client->cl_mvops->minor_version,
1723 parent_client->cl_net);
1727 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1731 error = nfs4_server_common_setup(server, mntfh);
1735 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1739 nfs_free_server(server);
1740 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1741 return ERR_PTR(error);
1744 #endif /* CONFIG_NFS_V4 */
1747 * Clone an NFS2, NFS3 or NFS4 server record
1749 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1751 struct nfs_fattr *fattr,
1752 rpc_authflavor_t flavor)
1754 struct nfs_server *server;
1755 struct nfs_fattr *fattr_fsinfo;
1758 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1759 (unsigned long long) fattr->fsid.major,
1760 (unsigned long long) fattr->fsid.minor);
1762 server = nfs_alloc_server();
1764 return ERR_PTR(-ENOMEM);
1767 fattr_fsinfo = nfs_alloc_fattr();
1768 if (fattr_fsinfo == NULL)
1769 goto out_free_server;
1771 /* Copy data from the source */
1772 server->nfs_client = source->nfs_client;
1773 server->destroy = source->destroy;
1774 atomic_inc(&server->nfs_client->cl_count);
1775 nfs_server_copy_userdata(server, source);
1777 server->fsid = fattr->fsid;
1779 error = nfs_init_server_rpcclient(server,
1780 source->client->cl_timeout,
1783 goto out_free_server;
1784 if (!IS_ERR(source->client_acl))
1785 nfs_init_server_aclclient(server);
1787 /* probe the filesystem info for this server filesystem */
1788 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1790 goto out_free_server;
1792 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1793 server->namelen = NFS4_MAXNAMLEN;
1795 dprintk("Cloned FSID: %llx:%llx\n",
1796 (unsigned long long) server->fsid.major,
1797 (unsigned long long) server->fsid.minor);
1799 error = nfs_start_lockd(server);
1801 goto out_free_server;
1803 nfs_server_insert_lists(server);
1804 server->mount_time = jiffies;
1806 nfs_free_fattr(fattr_fsinfo);
1807 dprintk("<-- nfs_clone_server() = %p\n", server);
1811 nfs_free_fattr(fattr_fsinfo);
1812 nfs_free_server(server);
1813 dprintk("<-- nfs_clone_server() = error %d\n", error);
1814 return ERR_PTR(error);
1817 void nfs_clients_init(struct net *net)
1819 struct nfs_net *nn = net_generic(net, nfs_net_id);
1821 INIT_LIST_HEAD(&nn->nfs_client_list);
1822 INIT_LIST_HEAD(&nn->nfs_volume_list);
1823 #ifdef CONFIG_NFS_V4
1824 idr_init(&nn->cb_ident_idr);
1826 spin_lock_init(&nn->nfs_client_lock);
1827 nn->boot_time = CURRENT_TIME;
1830 #ifdef CONFIG_PROC_FS
1831 static struct proc_dir_entry *proc_fs_nfs;
1833 static int nfs_server_list_open(struct inode *inode, struct file *file);
1834 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1835 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1836 static void nfs_server_list_stop(struct seq_file *p, void *v);
1837 static int nfs_server_list_show(struct seq_file *m, void *v);
1839 static const struct seq_operations nfs_server_list_ops = {
1840 .start = nfs_server_list_start,
1841 .next = nfs_server_list_next,
1842 .stop = nfs_server_list_stop,
1843 .show = nfs_server_list_show,
1846 static const struct file_operations nfs_server_list_fops = {
1847 .open = nfs_server_list_open,
1849 .llseek = seq_lseek,
1850 .release = seq_release,
1851 .owner = THIS_MODULE,
1854 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1855 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1856 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1857 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1858 static int nfs_volume_list_show(struct seq_file *m, void *v);
1860 static const struct seq_operations nfs_volume_list_ops = {
1861 .start = nfs_volume_list_start,
1862 .next = nfs_volume_list_next,
1863 .stop = nfs_volume_list_stop,
1864 .show = nfs_volume_list_show,
1867 static const struct file_operations nfs_volume_list_fops = {
1868 .open = nfs_volume_list_open,
1870 .llseek = seq_lseek,
1871 .release = seq_release,
1872 .owner = THIS_MODULE,
1876 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1879 static int nfs_server_list_open(struct inode *inode, struct file *file)
1883 struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1884 struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1886 ret = seq_open(file, &nfs_server_list_ops);
1890 m = file->private_data;
1897 * set up the iterator to start reading from the server list and return the first item
1899 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1901 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1903 /* lock the list against modification */
1904 spin_lock(&nn->nfs_client_lock);
1905 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1909 * move to next server
1911 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1913 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1915 return seq_list_next(v, &nn->nfs_client_list, pos);
1919 * clean up after reading from the transports list
1921 static void nfs_server_list_stop(struct seq_file *p, void *v)
1923 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1925 spin_unlock(&nn->nfs_client_lock);
1929 * display a header line followed by a load of call lines
1931 static int nfs_server_list_show(struct seq_file *m, void *v)
1933 struct nfs_client *clp;
1934 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1936 /* display header on line 1 */
1937 if (v == &nn->nfs_client_list) {
1938 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1942 /* display one transport per line on subsequent lines */
1943 clp = list_entry(v, struct nfs_client, cl_share_link);
1945 /* Check if the client is initialized */
1946 if (clp->cl_cons_state != NFS_CS_READY)
1950 seq_printf(m, "v%u %s %s %3d %s\n",
1951 clp->rpc_ops->version,
1952 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1953 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1954 atomic_read(&clp->cl_count),
1962 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1964 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1968 struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1969 struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1971 ret = seq_open(file, &nfs_volume_list_ops);
1975 m = file->private_data;
1982 * set up the iterator to start reading from the volume list and return the first item
1984 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1986 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1988 /* lock the list against modification */
1989 spin_lock(&nn->nfs_client_lock);
1990 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1994 * move to next volume
1996 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1998 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
2000 return seq_list_next(v, &nn->nfs_volume_list, pos);
2004 * clean up after reading from the transports list
2006 static void nfs_volume_list_stop(struct seq_file *p, void *v)
2008 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
2010 spin_unlock(&nn->nfs_client_lock);
2014 * display a header line followed by a load of call lines
2016 static int nfs_volume_list_show(struct seq_file *m, void *v)
2018 struct nfs_server *server;
2019 struct nfs_client *clp;
2020 char dev[8], fsid[17];
2021 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
2023 /* display header on line 1 */
2024 if (v == &nn->nfs_volume_list) {
2025 seq_puts(m, "NV SERVER PORT DEV FSID FSC\n");
2028 /* display one transport per line on subsequent lines */
2029 server = list_entry(v, struct nfs_server, master_link);
2030 clp = server->nfs_client;
2032 snprintf(dev, 8, "%u:%u",
2033 MAJOR(server->s_dev), MINOR(server->s_dev));
2035 snprintf(fsid, 17, "%llx:%llx",
2036 (unsigned long long) server->fsid.major,
2037 (unsigned long long) server->fsid.minor);
2040 seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
2041 clp->rpc_ops->version,
2042 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
2043 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
2046 nfs_server_fscache_state(server));
2053 * initialise the /proc/fs/nfsfs/ directory
2055 int __init nfs_fs_proc_init(void)
2057 struct proc_dir_entry *p;
2059 proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
2063 /* a file of servers with which we're dealing */
2064 p = proc_create("servers", S_IFREG|S_IRUGO,
2065 proc_fs_nfs, &nfs_server_list_fops);
2069 /* a file of volumes that we have mounted */
2070 p = proc_create("volumes", S_IFREG|S_IRUGO,
2071 proc_fs_nfs, &nfs_volume_list_fops);
2077 remove_proc_entry("servers", proc_fs_nfs);
2079 remove_proc_entry("fs/nfsfs", NULL);
2085 * clean up the /proc/fs/nfsfs/ directory
2087 void nfs_fs_proc_exit(void)
2089 remove_proc_entry("volumes", proc_fs_nfs);
2090 remove_proc_entry("servers", proc_fs_nfs);
2091 remove_proc_entry("fs/nfsfs", NULL);
2094 #endif /* CONFIG_PROC_FS */
2096 module_param(nfs4_disable_idmapping, bool, 0644);
2097 MODULE_PARM_DESC(nfs4_disable_idmapping,
2098 "Turn off NFSv4 idmapping when using 'sec=sys'");