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>
39 #include <linux/nfs_xdr.h>
41 #include <asm/system.h>
45 #include "delegation.h"
49 #define NFSDBG_FACILITY NFSDBG_CLIENT
51 static DEFINE_SPINLOCK(nfs_client_lock);
52 static LIST_HEAD(nfs_client_list);
53 static LIST_HEAD(nfs_volume_list);
54 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
59 static struct rpc_version *nfs_version[5] = {
69 struct rpc_program nfs_program = {
71 .number = NFS_PROGRAM,
72 .nrvers = ARRAY_SIZE(nfs_version),
73 .version = nfs_version,
74 .stats = &nfs_rpcstat,
75 .pipe_dir_name = "/nfs",
78 struct rpc_stat nfs_rpcstat = {
79 .program = &nfs_program
83 #ifdef CONFIG_NFS_V3_ACL
84 static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
85 static struct rpc_version * nfsacl_version[] = {
86 [3] = &nfsacl_version3,
89 struct rpc_program nfsacl_program = {
91 .number = NFS_ACL_PROGRAM,
92 .nrvers = ARRAY_SIZE(nfsacl_version),
93 .version = nfsacl_version,
94 .stats = &nfsacl_rpcstat,
96 #endif /* CONFIG_NFS_V3_ACL */
98 struct nfs_client_initdata {
100 const struct sockaddr *addr;
102 const struct nfs_rpc_ops *rpc_ops;
107 * Allocate a shared client record
109 * Since these are allocated/deallocated very rarely, we don't
110 * bother putting them in a slab cache...
112 static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
114 struct nfs_client *clp;
116 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
119 clp->rpc_ops = cl_init->rpc_ops;
121 if (cl_init->rpc_ops->version == 4) {
122 if (nfs_callback_up() < 0)
124 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
127 atomic_set(&clp->cl_count, 1);
128 clp->cl_cons_state = NFS_CS_INITING;
130 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
131 clp->cl_addrlen = cl_init->addrlen;
133 if (cl_init->hostname) {
134 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
135 if (!clp->cl_hostname)
139 INIT_LIST_HEAD(&clp->cl_superblocks);
140 clp->cl_rpcclient = ERR_PTR(-EINVAL);
142 clp->cl_proto = cl_init->proto;
145 init_rwsem(&clp->cl_sem);
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;
157 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
165 static void nfs4_shutdown_client(struct nfs_client *clp)
168 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
169 nfs4_kill_renewd(clp);
170 BUG_ON(!RB_EMPTY_ROOT(&clp->cl_state_owners));
171 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
172 nfs_idmap_delete(clp);
177 * Destroy a shared client record
179 static void nfs_free_client(struct nfs_client *clp)
181 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
183 nfs4_shutdown_client(clp);
185 /* -EIO all pending I/O */
186 if (!IS_ERR(clp->cl_rpcclient))
187 rpc_shutdown_client(clp->cl_rpcclient);
189 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
192 kfree(clp->cl_hostname);
195 dprintk("<-- nfs_free_client()\n");
199 * Release a reference to a shared client record
201 void nfs_put_client(struct nfs_client *clp)
206 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
208 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
209 list_del(&clp->cl_share_link);
210 spin_unlock(&nfs_client_lock);
212 BUG_ON(!list_empty(&clp->cl_superblocks));
214 nfs_free_client(clp);
218 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr_in *sa1,
219 const struct sockaddr_in *sa2)
221 return sa1->sin_addr.s_addr == sa2->sin_addr.s_addr;
224 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr_in6 *sa1,
225 const struct sockaddr_in6 *sa2)
227 return ipv6_addr_equal(&sa1->sin6_addr, &sa2->sin6_addr);
230 static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
231 const struct sockaddr *sa2)
233 switch (sa1->sa_family) {
235 return nfs_sockaddr_match_ipaddr4((const struct sockaddr_in *)sa1,
236 (const struct sockaddr_in *)sa2);
238 return nfs_sockaddr_match_ipaddr6((const struct sockaddr_in6 *)sa1,
239 (const struct sockaddr_in6 *)sa2);
245 * Find a client by IP address and protocol version
246 * - returns NULL if no such client
248 struct nfs_client *nfs_find_client(const struct sockaddr *addr, u32 nfsversion)
250 struct nfs_client *clp;
252 spin_lock(&nfs_client_lock);
253 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
254 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
256 /* Don't match clients that failed to initialise properly */
257 if (clp->cl_cons_state != NFS_CS_READY)
260 /* Different NFS versions cannot share the same nfs_client */
261 if (clp->rpc_ops->version != nfsversion)
264 if (addr->sa_family != clap->sa_family)
266 /* Match only the IP address, not the port number */
267 if (!nfs_sockaddr_match_ipaddr(addr, clap))
270 atomic_inc(&clp->cl_count);
271 spin_unlock(&nfs_client_lock);
274 spin_unlock(&nfs_client_lock);
279 * Find an nfs_client on the list that matches the initialisation data
282 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
284 struct nfs_client *clp;
286 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
287 /* Don't match clients that failed to initialise properly */
288 if (clp->cl_cons_state < 0)
291 /* Different NFS versions cannot share the same nfs_client */
292 if (clp->rpc_ops != data->rpc_ops)
295 if (clp->cl_proto != data->proto)
298 /* Match the full socket address */
299 if (memcmp(&clp->cl_addr, data->addr, sizeof(clp->cl_addr)) != 0)
302 atomic_inc(&clp->cl_count);
309 * Look up a client by IP address and protocol version
310 * - creates a new record if one doesn't yet exist
312 static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
314 struct nfs_client *clp, *new = NULL;
317 dprintk("--> nfs_get_client(%s,v%u)\n",
318 cl_init->hostname ?: "", cl_init->rpc_ops->version);
320 /* see if the client already exists */
322 spin_lock(&nfs_client_lock);
324 clp = nfs_match_client(cl_init);
330 spin_unlock(&nfs_client_lock);
332 new = nfs_alloc_client(cl_init);
335 return ERR_PTR(-ENOMEM);
337 /* install a new client and return with it unready */
340 list_add(&clp->cl_share_link, &nfs_client_list);
341 spin_unlock(&nfs_client_lock);
342 dprintk("--> nfs_get_client() = %p [new]\n", clp);
345 /* found an existing client
346 * - make sure it's ready before returning
349 spin_unlock(&nfs_client_lock);
352 nfs_free_client(new);
354 error = wait_event_interruptible(nfs_client_active_wq,
355 clp->cl_cons_state != NFS_CS_INITING);
358 return ERR_PTR(-ERESTARTSYS);
361 if (clp->cl_cons_state < NFS_CS_READY) {
362 error = clp->cl_cons_state;
364 return ERR_PTR(error);
367 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
369 dprintk("--> nfs_get_client() = %p [share]\n", clp);
374 * Mark a server as ready or failed
376 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
378 clp->cl_cons_state = state;
379 wake_up_all(&nfs_client_active_wq);
383 * Initialise the timeout values for a connection
385 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
386 unsigned int timeo, unsigned int retrans)
388 to->to_initval = timeo * HZ / 10;
389 to->to_retries = retrans;
394 case XPRT_TRANSPORT_TCP:
395 case XPRT_TRANSPORT_RDMA:
396 if (to->to_initval == 0)
397 to->to_initval = 60 * HZ;
398 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
399 to->to_initval = NFS_MAX_TCP_TIMEOUT;
400 to->to_increment = to->to_initval;
401 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
402 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
403 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
404 if (to->to_maxval < to->to_initval)
405 to->to_maxval = to->to_initval;
406 to->to_exponential = 0;
408 case XPRT_TRANSPORT_UDP:
411 to->to_initval = 11 * HZ / 10;
412 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
413 to->to_initval = NFS_MAX_UDP_TIMEOUT;
414 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
415 to->to_exponential = 1;
421 * Create an RPC client handle
423 static int nfs_create_rpc_client(struct nfs_client *clp,
424 const struct rpc_timeout *timeparms,
425 rpc_authflavor_t flavor,
428 struct rpc_clnt *clnt = NULL;
429 struct rpc_create_args args = {
430 .protocol = clp->cl_proto,
431 .address = (struct sockaddr *)&clp->cl_addr,
432 .addrsize = clp->cl_addrlen,
433 .timeout = timeparms,
434 .servername = clp->cl_hostname,
435 .program = &nfs_program,
436 .version = clp->rpc_ops->version,
437 .authflavor = flavor,
441 if (!IS_ERR(clp->cl_rpcclient))
444 clnt = rpc_create(&args);
446 dprintk("%s: cannot create RPC client. Error = %ld\n",
447 __FUNCTION__, PTR_ERR(clnt));
448 return PTR_ERR(clnt);
451 clp->cl_rpcclient = clnt;
456 * Version 2 or 3 client destruction
458 static void nfs_destroy_server(struct nfs_server *server)
460 if (!(server->flags & NFS_MOUNT_NONLM))
461 nlmclnt_done(server->nlm_host);
465 * Version 2 or 3 lockd setup
467 static int nfs_start_lockd(struct nfs_server *server)
469 struct nlm_host *host;
470 struct nfs_client *clp = server->nfs_client;
471 u32 nfs_version = clp->rpc_ops->version;
472 unsigned short protocol = server->flags & NFS_MOUNT_TCP ?
473 IPPROTO_TCP : IPPROTO_UDP;
477 if (server->flags & NFS_MOUNT_NONLM)
480 host = nlmclnt_init(clp->cl_hostname,
481 (struct sockaddr *)&clp->cl_addr,
482 clp->cl_addrlen, protocol, nfs_version);
484 return PTR_ERR(host);
486 server->nlm_host = host;
487 server->destroy = nfs_destroy_server;
492 * Initialise an NFSv3 ACL client connection
494 #ifdef CONFIG_NFS_V3_ACL
495 static void nfs_init_server_aclclient(struct nfs_server *server)
497 if (server->nfs_client->rpc_ops->version != 3)
499 if (server->flags & NFS_MOUNT_NOACL)
502 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
503 if (IS_ERR(server->client_acl))
506 /* No errors! Assume that Sun nfsacls are supported */
507 server->caps |= NFS_CAP_ACLS;
511 server->caps &= ~NFS_CAP_ACLS;
514 static inline void nfs_init_server_aclclient(struct nfs_server *server)
516 server->flags &= ~NFS_MOUNT_NOACL;
517 server->caps &= ~NFS_CAP_ACLS;
522 * Create a general RPC client
524 static int nfs_init_server_rpcclient(struct nfs_server *server,
525 const struct rpc_timeout *timeo,
526 rpc_authflavor_t pseudoflavour)
528 struct nfs_client *clp = server->nfs_client;
530 server->client = rpc_clone_client(clp->cl_rpcclient);
531 if (IS_ERR(server->client)) {
532 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
533 return PTR_ERR(server->client);
536 memcpy(&server->client->cl_timeout_default,
538 sizeof(server->client->cl_timeout_default));
539 server->client->cl_timeout = &server->client->cl_timeout_default;
541 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
542 struct rpc_auth *auth;
544 auth = rpcauth_create(pseudoflavour, server->client);
546 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
547 return PTR_ERR(auth);
550 server->client->cl_softrtry = 0;
551 if (server->flags & NFS_MOUNT_SOFT)
552 server->client->cl_softrtry = 1;
554 server->client->cl_intr = 0;
555 if (server->flags & NFS4_MOUNT_INTR)
556 server->client->cl_intr = 1;
562 * Initialise an NFS2 or NFS3 client
564 static int nfs_init_client(struct nfs_client *clp,
565 const struct rpc_timeout *timeparms,
566 const struct nfs_parsed_mount_data *data)
570 if (clp->cl_cons_state == NFS_CS_READY) {
571 /* the client is already initialised */
572 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
577 * Create a client RPC handle for doing FSSTAT with UNIX auth only
578 * - RFC 2623, sec 2.3.2
580 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX, 0);
583 nfs_mark_client_ready(clp, NFS_CS_READY);
587 nfs_mark_client_ready(clp, error);
588 dprintk("<-- nfs_init_client() = xerror %d\n", error);
593 * Create a version 2 or 3 client
595 static int nfs_init_server(struct nfs_server *server,
596 const struct nfs_parsed_mount_data *data)
598 struct nfs_client_initdata cl_init = {
599 .hostname = data->nfs_server.hostname,
600 .addr = (const struct sockaddr *)&data->nfs_server.address,
601 .addrlen = data->nfs_server.addrlen,
602 .rpc_ops = &nfs_v2_clientops,
603 .proto = data->nfs_server.protocol,
605 struct rpc_timeout timeparms;
606 struct nfs_client *clp;
609 dprintk("--> nfs_init_server()\n");
612 if (data->flags & NFS_MOUNT_VER3)
613 cl_init.rpc_ops = &nfs_v3_clientops;
616 /* Allocate or find a client reference we can use */
617 clp = nfs_get_client(&cl_init);
619 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
623 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
624 data->timeo, data->retrans);
625 error = nfs_init_client(clp, &timeparms, data);
629 server->nfs_client = clp;
631 /* Initialise the client representation from the mount data */
632 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
635 server->rsize = nfs_block_size(data->rsize, NULL);
637 server->wsize = nfs_block_size(data->wsize, NULL);
639 server->acregmin = data->acregmin * HZ;
640 server->acregmax = data->acregmax * HZ;
641 server->acdirmin = data->acdirmin * HZ;
642 server->acdirmax = data->acdirmax * HZ;
644 /* Start lockd here, before we might error out */
645 error = nfs_start_lockd(server);
649 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
653 server->namelen = data->namlen;
654 /* Create a client RPC handle for the NFSv3 ACL management interface */
655 nfs_init_server_aclclient(server);
656 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
660 server->nfs_client = NULL;
662 dprintk("<-- nfs_init_server() = xerror %d\n", error);
667 * Load up the server record from information gained in an fsinfo record
669 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
671 unsigned long max_rpc_payload;
673 /* Work out a lot of parameters */
674 if (server->rsize == 0)
675 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
676 if (server->wsize == 0)
677 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
679 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
680 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
681 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
682 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
684 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
685 if (server->rsize > max_rpc_payload)
686 server->rsize = max_rpc_payload;
687 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
688 server->rsize = NFS_MAX_FILE_IO_SIZE;
689 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
691 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
693 if (server->wsize > max_rpc_payload)
694 server->wsize = max_rpc_payload;
695 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
696 server->wsize = NFS_MAX_FILE_IO_SIZE;
697 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
698 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
700 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
701 if (server->dtsize > PAGE_CACHE_SIZE)
702 server->dtsize = PAGE_CACHE_SIZE;
703 if (server->dtsize > server->rsize)
704 server->dtsize = server->rsize;
706 if (server->flags & NFS_MOUNT_NOAC) {
707 server->acregmin = server->acregmax = 0;
708 server->acdirmin = server->acdirmax = 0;
711 server->maxfilesize = fsinfo->maxfilesize;
713 /* We're airborne Set socket buffersize */
714 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
718 * Probe filesystem information, including the FSID on v2/v3
720 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
722 struct nfs_fsinfo fsinfo;
723 struct nfs_client *clp = server->nfs_client;
726 dprintk("--> nfs_probe_fsinfo()\n");
728 if (clp->rpc_ops->set_capabilities != NULL) {
729 error = clp->rpc_ops->set_capabilities(server, mntfh);
734 fsinfo.fattr = fattr;
735 nfs_fattr_init(fattr);
736 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
740 nfs_server_set_fsinfo(server, &fsinfo);
741 error = bdi_init(&server->backing_dev_info);
746 /* Get some general file system info */
747 if (server->namelen == 0) {
748 struct nfs_pathconf pathinfo;
750 pathinfo.fattr = fattr;
751 nfs_fattr_init(fattr);
753 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
754 server->namelen = pathinfo.max_namelen;
757 dprintk("<-- nfs_probe_fsinfo() = 0\n");
761 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
766 * Copy useful information when duplicating a server record
768 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
770 target->flags = source->flags;
771 target->acregmin = source->acregmin;
772 target->acregmax = source->acregmax;
773 target->acdirmin = source->acdirmin;
774 target->acdirmax = source->acdirmax;
775 target->caps = source->caps;
779 * Allocate and initialise a server record
781 static struct nfs_server *nfs_alloc_server(void)
783 struct nfs_server *server;
785 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
789 server->client = server->client_acl = ERR_PTR(-EINVAL);
791 /* Zero out the NFS state stuff */
792 INIT_LIST_HEAD(&server->client_link);
793 INIT_LIST_HEAD(&server->master_link);
795 init_waitqueue_head(&server->active_wq);
796 atomic_set(&server->active, 0);
798 server->io_stats = nfs_alloc_iostats();
799 if (!server->io_stats) {
808 * Free up a server record
810 void nfs_free_server(struct nfs_server *server)
812 dprintk("--> nfs_free_server()\n");
814 spin_lock(&nfs_client_lock);
815 list_del(&server->client_link);
816 list_del(&server->master_link);
817 spin_unlock(&nfs_client_lock);
819 if (server->destroy != NULL)
820 server->destroy(server);
822 if (!IS_ERR(server->client_acl))
823 rpc_shutdown_client(server->client_acl);
824 if (!IS_ERR(server->client))
825 rpc_shutdown_client(server->client);
827 nfs_put_client(server->nfs_client);
829 nfs_free_iostats(server->io_stats);
830 bdi_destroy(&server->backing_dev_info);
832 nfs_release_automount_timer();
833 dprintk("<-- nfs_free_server()\n");
837 * Create a version 2 or 3 volume record
838 * - keyed on server and FSID
840 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
841 struct nfs_fh *mntfh)
843 struct nfs_server *server;
844 struct nfs_fattr fattr;
847 server = nfs_alloc_server();
849 return ERR_PTR(-ENOMEM);
851 /* Get a client representation */
852 error = nfs_init_server(server, data);
856 BUG_ON(!server->nfs_client);
857 BUG_ON(!server->nfs_client->rpc_ops);
858 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
860 /* Probe the root fh to retrieve its FSID */
861 error = nfs_probe_fsinfo(server, mntfh, &fattr);
864 if (server->nfs_client->rpc_ops->version == 3) {
865 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
866 server->namelen = NFS3_MAXNAMLEN;
867 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
868 server->caps |= NFS_CAP_READDIRPLUS;
870 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
871 server->namelen = NFS2_MAXNAMLEN;
874 if (!(fattr.valid & NFS_ATTR_FATTR)) {
875 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
877 dprintk("nfs_create_server: getattr error = %d\n", -error);
881 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
883 dprintk("Server FSID: %llx:%llx\n",
884 (unsigned long long) server->fsid.major,
885 (unsigned long long) server->fsid.minor);
887 BUG_ON(!server->nfs_client);
888 BUG_ON(!server->nfs_client->rpc_ops);
889 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
891 spin_lock(&nfs_client_lock);
892 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
893 list_add_tail(&server->master_link, &nfs_volume_list);
894 spin_unlock(&nfs_client_lock);
896 server->mount_time = jiffies;
900 nfs_free_server(server);
901 return ERR_PTR(error);
906 * Initialise an NFS4 client record
908 static int nfs4_init_client(struct nfs_client *clp,
909 const struct rpc_timeout *timeparms,
911 rpc_authflavor_t authflavour)
915 if (clp->cl_cons_state == NFS_CS_READY) {
916 /* the client is initialised already */
917 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
921 /* Check NFS protocol revision and initialize RPC op vector */
922 clp->rpc_ops = &nfs_v4_clientops;
924 error = nfs_create_rpc_client(clp, timeparms, authflavour,
925 RPC_CLNT_CREATE_DISCRTRY);
928 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
930 error = nfs_idmap_new(clp);
932 dprintk("%s: failed to create idmapper. Error = %d\n",
933 __FUNCTION__, error);
936 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
938 nfs_mark_client_ready(clp, NFS_CS_READY);
942 nfs_mark_client_ready(clp, error);
943 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
948 * Set up an NFS4 client
950 static int nfs4_set_client(struct nfs_server *server,
951 const char *hostname,
952 const struct sockaddr *addr,
953 const size_t addrlen,
955 rpc_authflavor_t authflavour,
956 int proto, const struct rpc_timeout *timeparms)
958 struct nfs_client_initdata cl_init = {
959 .hostname = hostname,
962 .rpc_ops = &nfs_v4_clientops,
965 struct nfs_client *clp;
968 dprintk("--> nfs4_set_client()\n");
970 /* Allocate or find a client reference we can use */
971 clp = nfs_get_client(&cl_init);
973 error = PTR_ERR(clp);
976 error = nfs4_init_client(clp, timeparms, ip_addr, authflavour);
980 server->nfs_client = clp;
981 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
987 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
992 * Create a version 4 volume record
994 static int nfs4_init_server(struct nfs_server *server,
995 const struct nfs_parsed_mount_data *data)
997 struct rpc_timeout timeparms;
1000 dprintk("--> nfs4_init_server()\n");
1002 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1003 data->timeo, data->retrans);
1005 /* Get a client record */
1006 error = nfs4_set_client(server,
1007 data->nfs_server.hostname,
1008 (const struct sockaddr *)&data->nfs_server.address,
1009 data->nfs_server.addrlen,
1010 data->client_address,
1011 data->auth_flavors[0],
1012 data->nfs_server.protocol,
1017 /* Initialise the client representation from the mount data */
1018 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
1019 server->caps |= NFS_CAP_ATOMIC_OPEN;
1022 server->rsize = nfs_block_size(data->rsize, NULL);
1024 server->wsize = nfs_block_size(data->wsize, NULL);
1026 server->acregmin = data->acregmin * HZ;
1027 server->acregmax = data->acregmax * HZ;
1028 server->acdirmin = data->acdirmin * HZ;
1029 server->acdirmax = data->acdirmax * HZ;
1031 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1035 dprintk("<-- nfs4_init_server() = %d\n", error);
1040 * Create a version 4 volume record
1041 * - keyed on server and FSID
1043 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1044 struct nfs_fh *mntfh)
1046 struct nfs_fattr fattr;
1047 struct nfs_server *server;
1050 dprintk("--> nfs4_create_server()\n");
1052 server = nfs_alloc_server();
1054 return ERR_PTR(-ENOMEM);
1056 /* set up the general RPC client */
1057 error = nfs4_init_server(server, data);
1061 BUG_ON(!server->nfs_client);
1062 BUG_ON(!server->nfs_client->rpc_ops);
1063 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1065 /* Probe the root fh to retrieve its FSID */
1066 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1070 dprintk("Server FSID: %llx:%llx\n",
1071 (unsigned long long) server->fsid.major,
1072 (unsigned long long) server->fsid.minor);
1073 dprintk("Mount FH: %d\n", mntfh->size);
1075 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1079 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1080 server->namelen = NFS4_MAXNAMLEN;
1082 BUG_ON(!server->nfs_client);
1083 BUG_ON(!server->nfs_client->rpc_ops);
1084 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1086 spin_lock(&nfs_client_lock);
1087 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1088 list_add_tail(&server->master_link, &nfs_volume_list);
1089 spin_unlock(&nfs_client_lock);
1091 server->mount_time = jiffies;
1092 dprintk("<-- nfs4_create_server() = %p\n", server);
1096 nfs_free_server(server);
1097 dprintk("<-- nfs4_create_server() = error %d\n", error);
1098 return ERR_PTR(error);
1102 * Create an NFS4 referral server record
1104 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1105 struct nfs_fh *mntfh)
1107 struct nfs_client *parent_client;
1108 struct nfs_server *server, *parent_server;
1109 struct nfs_fattr fattr;
1112 dprintk("--> nfs4_create_referral_server()\n");
1114 server = nfs_alloc_server();
1116 return ERR_PTR(-ENOMEM);
1118 parent_server = NFS_SB(data->sb);
1119 parent_client = parent_server->nfs_client;
1121 /* Get a client representation.
1122 * Note: NFSv4 always uses TCP, */
1123 error = nfs4_set_client(server, data->hostname,
1126 parent_client->cl_ipaddr,
1128 parent_server->client->cl_xprt->prot,
1129 parent_server->client->cl_timeout);
1133 /* Initialise the client representation from the parent server */
1134 nfs_server_copy_userdata(server, parent_server);
1135 server->caps |= NFS_CAP_ATOMIC_OPEN;
1137 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1141 BUG_ON(!server->nfs_client);
1142 BUG_ON(!server->nfs_client->rpc_ops);
1143 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1145 /* Probe the root fh to retrieve its FSID and filehandle */
1146 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1150 /* probe the filesystem info for this server filesystem */
1151 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1155 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1156 server->namelen = NFS4_MAXNAMLEN;
1158 dprintk("Referral FSID: %llx:%llx\n",
1159 (unsigned long long) server->fsid.major,
1160 (unsigned long long) server->fsid.minor);
1162 spin_lock(&nfs_client_lock);
1163 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1164 list_add_tail(&server->master_link, &nfs_volume_list);
1165 spin_unlock(&nfs_client_lock);
1167 server->mount_time = jiffies;
1169 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1173 nfs_free_server(server);
1174 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1175 return ERR_PTR(error);
1178 #endif /* CONFIG_NFS_V4 */
1181 * Clone an NFS2, NFS3 or NFS4 server record
1183 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1185 struct nfs_fattr *fattr)
1187 struct nfs_server *server;
1188 struct nfs_fattr fattr_fsinfo;
1191 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1192 (unsigned long long) fattr->fsid.major,
1193 (unsigned long long) fattr->fsid.minor);
1195 server = nfs_alloc_server();
1197 return ERR_PTR(-ENOMEM);
1199 /* Copy data from the source */
1200 server->nfs_client = source->nfs_client;
1201 atomic_inc(&server->nfs_client->cl_count);
1202 nfs_server_copy_userdata(server, source);
1204 server->fsid = fattr->fsid;
1206 error = nfs_init_server_rpcclient(server,
1207 source->client->cl_timeout,
1208 source->client->cl_auth->au_flavor);
1210 goto out_free_server;
1211 if (!IS_ERR(source->client_acl))
1212 nfs_init_server_aclclient(server);
1214 /* probe the filesystem info for this server filesystem */
1215 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1217 goto out_free_server;
1219 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1220 server->namelen = NFS4_MAXNAMLEN;
1222 dprintk("Cloned FSID: %llx:%llx\n",
1223 (unsigned long long) server->fsid.major,
1224 (unsigned long long) server->fsid.minor);
1226 error = nfs_start_lockd(server);
1228 goto out_free_server;
1230 spin_lock(&nfs_client_lock);
1231 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1232 list_add_tail(&server->master_link, &nfs_volume_list);
1233 spin_unlock(&nfs_client_lock);
1235 server->mount_time = jiffies;
1237 dprintk("<-- nfs_clone_server() = %p\n", server);
1241 nfs_free_server(server);
1242 dprintk("<-- nfs_clone_server() = error %d\n", error);
1243 return ERR_PTR(error);
1246 #ifdef CONFIG_PROC_FS
1247 static struct proc_dir_entry *proc_fs_nfs;
1249 static int nfs_server_list_open(struct inode *inode, struct file *file);
1250 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1251 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1252 static void nfs_server_list_stop(struct seq_file *p, void *v);
1253 static int nfs_server_list_show(struct seq_file *m, void *v);
1255 static struct seq_operations nfs_server_list_ops = {
1256 .start = nfs_server_list_start,
1257 .next = nfs_server_list_next,
1258 .stop = nfs_server_list_stop,
1259 .show = nfs_server_list_show,
1262 static const struct file_operations nfs_server_list_fops = {
1263 .open = nfs_server_list_open,
1265 .llseek = seq_lseek,
1266 .release = seq_release,
1269 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1270 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1271 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1272 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1273 static int nfs_volume_list_show(struct seq_file *m, void *v);
1275 static struct seq_operations nfs_volume_list_ops = {
1276 .start = nfs_volume_list_start,
1277 .next = nfs_volume_list_next,
1278 .stop = nfs_volume_list_stop,
1279 .show = nfs_volume_list_show,
1282 static const struct file_operations nfs_volume_list_fops = {
1283 .open = nfs_volume_list_open,
1285 .llseek = seq_lseek,
1286 .release = seq_release,
1290 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1293 static int nfs_server_list_open(struct inode *inode, struct file *file)
1298 ret = seq_open(file, &nfs_server_list_ops);
1302 m = file->private_data;
1303 m->private = PDE(inode)->data;
1309 * set up the iterator to start reading from the server list and return the first item
1311 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1313 /* lock the list against modification */
1314 spin_lock(&nfs_client_lock);
1315 return seq_list_start_head(&nfs_client_list, *_pos);
1319 * move to next server
1321 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1323 return seq_list_next(v, &nfs_client_list, pos);
1327 * clean up after reading from the transports list
1329 static void nfs_server_list_stop(struct seq_file *p, void *v)
1331 spin_unlock(&nfs_client_lock);
1335 * display a header line followed by a load of call lines
1337 static int nfs_server_list_show(struct seq_file *m, void *v)
1339 struct nfs_client *clp;
1341 /* display header on line 1 */
1342 if (v == &nfs_client_list) {
1343 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1347 /* display one transport per line on subsequent lines */
1348 clp = list_entry(v, struct nfs_client, cl_share_link);
1350 seq_printf(m, "v%u %s %s %3d %s\n",
1351 clp->rpc_ops->version,
1352 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1353 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1354 atomic_read(&clp->cl_count),
1361 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1363 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1368 ret = seq_open(file, &nfs_volume_list_ops);
1372 m = file->private_data;
1373 m->private = PDE(inode)->data;
1379 * set up the iterator to start reading from the volume list and return the first item
1381 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1383 /* lock the list against modification */
1384 spin_lock(&nfs_client_lock);
1385 return seq_list_start_head(&nfs_volume_list, *_pos);
1389 * move to next volume
1391 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1393 return seq_list_next(v, &nfs_volume_list, pos);
1397 * clean up after reading from the transports list
1399 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1401 spin_unlock(&nfs_client_lock);
1405 * display a header line followed by a load of call lines
1407 static int nfs_volume_list_show(struct seq_file *m, void *v)
1409 struct nfs_server *server;
1410 struct nfs_client *clp;
1411 char dev[8], fsid[17];
1413 /* display header on line 1 */
1414 if (v == &nfs_volume_list) {
1415 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1418 /* display one transport per line on subsequent lines */
1419 server = list_entry(v, struct nfs_server, master_link);
1420 clp = server->nfs_client;
1422 snprintf(dev, 8, "%u:%u",
1423 MAJOR(server->s_dev), MINOR(server->s_dev));
1425 snprintf(fsid, 17, "%llx:%llx",
1426 (unsigned long long) server->fsid.major,
1427 (unsigned long long) server->fsid.minor);
1429 seq_printf(m, "v%u %s %s %-7s %-17s\n",
1430 clp->rpc_ops->version,
1431 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1432 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1440 * initialise the /proc/fs/nfsfs/ directory
1442 int __init nfs_fs_proc_init(void)
1444 struct proc_dir_entry *p;
1446 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1450 proc_fs_nfs->owner = THIS_MODULE;
1452 /* a file of servers with which we're dealing */
1453 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1457 p->proc_fops = &nfs_server_list_fops;
1458 p->owner = THIS_MODULE;
1460 /* a file of volumes that we have mounted */
1461 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1465 p->proc_fops = &nfs_volume_list_fops;
1466 p->owner = THIS_MODULE;
1470 remove_proc_entry("servers", proc_fs_nfs);
1472 remove_proc_entry("nfsfs", proc_root_fs);
1478 * clean up the /proc/fs/nfsfs/ directory
1480 void nfs_fs_proc_exit(void)
1482 remove_proc_entry("volumes", proc_fs_nfs);
1483 remove_proc_entry("servers", proc_fs_nfs);
1484 remove_proc_entry("nfsfs", proc_root_fs);
1487 #endif /* CONFIG_PROC_FS */