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>
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/nfs_fs.h>
27 #include <linux/nfs_mount.h>
28 #include <linux/nfs4_mount.h>
29 #include <linux/lockd/bind.h>
30 #include <linux/smp_lock.h>
31 #include <linux/seq_file.h>
32 #include <linux/mount.h>
33 #include <linux/nfs_idmap.h>
34 #include <linux/vfs.h>
35 #include <linux/inet.h>
36 #include <linux/nfs_xdr.h>
38 #include <asm/system.h>
42 #include "delegation.h"
46 #define NFSDBG_FACILITY NFSDBG_CLIENT
48 static DEFINE_SPINLOCK(nfs_client_lock);
49 static LIST_HEAD(nfs_client_list);
50 static LIST_HEAD(nfs_volume_list);
51 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
56 static struct rpc_version *nfs_version[5] = {
66 struct rpc_program nfs_program = {
68 .number = NFS_PROGRAM,
69 .nrvers = ARRAY_SIZE(nfs_version),
70 .version = nfs_version,
71 .stats = &nfs_rpcstat,
72 .pipe_dir_name = "/nfs",
75 struct rpc_stat nfs_rpcstat = {
76 .program = &nfs_program
80 #ifdef CONFIG_NFS_V3_ACL
81 static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
82 static struct rpc_version * nfsacl_version[] = {
83 [3] = &nfsacl_version3,
86 struct rpc_program nfsacl_program = {
88 .number = NFS_ACL_PROGRAM,
89 .nrvers = ARRAY_SIZE(nfsacl_version),
90 .version = nfsacl_version,
91 .stats = &nfsacl_rpcstat,
93 #endif /* CONFIG_NFS_V3_ACL */
96 * Allocate a shared client record
98 * Since these are allocated/deallocated very rarely, we don't
99 * bother putting them in a slab cache...
101 static struct nfs_client *nfs_alloc_client(const char *hostname,
102 const struct sockaddr_in *addr,
105 struct nfs_client *clp;
108 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
113 dprintk("%s: couldn't start rpciod! Error = %d\n",
114 __FUNCTION__, error);
117 __set_bit(NFS_CS_RPCIOD, &clp->cl_res_state);
119 if (nfsversion == 4) {
120 if (nfs_callback_up() < 0)
122 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
125 atomic_set(&clp->cl_count, 1);
126 clp->cl_cons_state = NFS_CS_INITING;
128 clp->cl_nfsversion = nfsversion;
129 memcpy(&clp->cl_addr, addr, sizeof(clp->cl_addr));
132 clp->cl_hostname = kstrdup(hostname, GFP_KERNEL);
133 if (!clp->cl_hostname)
137 INIT_LIST_HEAD(&clp->cl_superblocks);
138 clp->cl_rpcclient = ERR_PTR(-EINVAL);
141 init_rwsem(&clp->cl_sem);
142 INIT_LIST_HEAD(&clp->cl_delegations);
143 INIT_LIST_HEAD(&clp->cl_state_owners);
144 INIT_LIST_HEAD(&clp->cl_unused);
145 spin_lock_init(&clp->cl_lock);
146 INIT_WORK(&clp->cl_renewd, nfs4_renew_state, clp);
147 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
148 clp->cl_boot_time = CURRENT_TIME;
149 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
152 nfs_fscache_get_client_cookie(clp);
157 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
161 __clear_bit(NFS_CS_RPCIOD, &clp->cl_res_state);
168 static void nfs4_shutdown_client(struct nfs_client *clp)
171 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
172 nfs4_kill_renewd(clp);
173 while (!list_empty(&clp->cl_unused)) {
174 struct nfs4_state_owner *sp;
176 sp = list_entry(clp->cl_unused.next,
177 struct nfs4_state_owner,
179 list_del(&sp->so_list);
182 BUG_ON(!list_empty(&clp->cl_state_owners));
183 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
184 nfs_idmap_delete(clp);
189 * Destroy a shared client record
191 static void nfs_free_client(struct nfs_client *clp)
193 dprintk("--> nfs_free_client(%d)\n", clp->cl_nfsversion);
195 nfs4_shutdown_client(clp);
197 nfs_fscache_release_client_cookie(clp);
199 /* -EIO all pending I/O */
200 if (!IS_ERR(clp->cl_rpcclient))
201 rpc_shutdown_client(clp->cl_rpcclient);
203 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
206 if (__test_and_clear_bit(NFS_CS_RPCIOD, &clp->cl_res_state))
209 kfree(clp->cl_hostname);
212 dprintk("<-- nfs_free_client()\n");
216 * Release a reference to a shared client record
218 void nfs_put_client(struct nfs_client *clp)
223 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
225 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
226 list_del(&clp->cl_share_link);
227 spin_unlock(&nfs_client_lock);
229 BUG_ON(!list_empty(&clp->cl_superblocks));
231 nfs_free_client(clp);
236 * Find a client by address
237 * - caller must hold nfs_client_lock
239 static struct nfs_client *__nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
241 struct nfs_client *clp;
243 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
244 /* Different NFS versions cannot share the same nfs_client */
245 if (clp->cl_nfsversion != nfsversion)
248 if (memcmp(&clp->cl_addr.sin_addr, &addr->sin_addr,
249 sizeof(clp->cl_addr.sin_addr)) != 0)
252 if (clp->cl_addr.sin_port == addr->sin_port)
259 atomic_inc(&clp->cl_count);
264 * Find a client by IP address and protocol version
265 * - returns NULL if no such client
267 struct nfs_client *nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
269 struct nfs_client *clp;
271 spin_lock(&nfs_client_lock);
272 clp = __nfs_find_client(addr, nfsversion);
273 spin_unlock(&nfs_client_lock);
275 BUG_ON(clp->cl_cons_state == 0);
281 * Look up a client by IP address and protocol version
282 * - creates a new record if one doesn't yet exist
284 static struct nfs_client *nfs_get_client(const char *hostname,
285 const struct sockaddr_in *addr,
288 struct nfs_client *clp, *new = NULL;
291 dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT":%d,%d)\n",
292 hostname ?: "", NIPQUAD(addr->sin_addr),
293 addr->sin_port, nfsversion);
295 /* see if the client already exists */
297 spin_lock(&nfs_client_lock);
299 clp = __nfs_find_client(addr, nfsversion);
305 spin_unlock(&nfs_client_lock);
307 new = nfs_alloc_client(hostname, addr, nfsversion);
310 return ERR_PTR(-ENOMEM);
312 /* install a new client and return with it unready */
315 list_add(&clp->cl_share_link, &nfs_client_list);
316 spin_unlock(&nfs_client_lock);
317 dprintk("--> nfs_get_client() = %p [new]\n", clp);
320 /* found an existing client
321 * - make sure it's ready before returning
324 spin_unlock(&nfs_client_lock);
327 nfs_free_client(new);
329 error = wait_event_interruptible(nfs_client_active_wq,
330 clp->cl_cons_state != NFS_CS_INITING);
333 return ERR_PTR(-ERESTARTSYS);
336 if (clp->cl_cons_state < NFS_CS_READY) {
337 error = clp->cl_cons_state;
339 return ERR_PTR(error);
342 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
344 dprintk("--> nfs_get_client() = %p [share]\n", clp);
349 * Mark a server as ready or failed
351 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
353 clp->cl_cons_state = state;
354 wake_up_all(&nfs_client_active_wq);
358 * Initialise the timeout values for a connection
360 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
361 unsigned int timeo, unsigned int retrans)
363 to->to_initval = timeo * HZ / 10;
364 to->to_retries = retrans;
371 to->to_initval = 60 * HZ;
372 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
373 to->to_initval = NFS_MAX_TCP_TIMEOUT;
374 to->to_increment = to->to_initval;
375 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
376 to->to_exponential = 0;
381 to->to_initval = 11 * HZ / 10;
382 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
383 to->to_initval = NFS_MAX_UDP_TIMEOUT;
384 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
385 to->to_exponential = 1;
391 * Create an RPC client handle
393 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
395 unsigned int retrans,
396 rpc_authflavor_t flavor)
398 struct rpc_timeout timeparms;
399 struct rpc_xprt *xprt = NULL;
400 struct rpc_clnt *clnt = NULL;
402 if (!IS_ERR(clp->cl_rpcclient))
405 nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
406 clp->retrans_timeo = timeparms.to_initval;
407 clp->retrans_count = timeparms.to_retries;
409 /* create transport and client */
410 xprt = xprt_create_proto(proto, &clp->cl_addr, &timeparms);
412 dprintk("%s: cannot create RPC transport. Error = %ld\n",
413 __FUNCTION__, PTR_ERR(xprt));
414 return PTR_ERR(xprt);
417 /* Bind to a reserved port! */
419 /* Create the client RPC handle */
420 clnt = rpc_create_client(xprt, clp->cl_hostname, &nfs_program,
421 clp->rpc_ops->version, RPC_AUTH_UNIX);
423 dprintk("%s: cannot create RPC client. Error = %ld\n",
424 __FUNCTION__, PTR_ERR(clnt));
425 return PTR_ERR(clnt);
429 clnt->cl_softrtry = 1;
431 clp->cl_rpcclient = clnt;
436 * Version 2 or 3 client destruction
438 static void nfs_destroy_server(struct nfs_server *server)
440 if (!IS_ERR(server->client_acl))
441 rpc_shutdown_client(server->client_acl);
443 if (!(server->flags & NFS_MOUNT_NONLM))
444 lockd_down(); /* release rpc.lockd */
448 * Version 2 or 3 lockd setup
450 static int nfs_start_lockd(struct nfs_server *server)
454 if (server->nfs_client->cl_nfsversion > 3)
456 if (server->flags & NFS_MOUNT_NONLM)
460 server->flags |= NFS_MOUNT_NONLM;
462 server->destroy = nfs_destroy_server;
468 * Initialise an NFSv3 ACL client connection
470 #ifdef CONFIG_NFS_V3_ACL
471 static void nfs_init_server_aclclient(struct nfs_server *server)
473 if (server->nfs_client->cl_nfsversion != 3)
475 if (server->flags & NFS_MOUNT_NOACL)
478 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
479 if (IS_ERR(server->client_acl))
482 /* No errors! Assume that Sun nfsacls are supported */
483 server->caps |= NFS_CAP_ACLS;
487 server->caps &= ~NFS_CAP_ACLS;
490 static inline void nfs_init_server_aclclient(struct nfs_server *server)
492 server->flags &= ~NFS_MOUNT_NOACL;
493 server->caps &= ~NFS_CAP_ACLS;
498 * Create a general RPC client
500 static int nfs_init_server_rpcclient(struct nfs_server *server, rpc_authflavor_t pseudoflavour)
502 struct nfs_client *clp = server->nfs_client;
504 server->client = rpc_clone_client(clp->cl_rpcclient);
505 if (IS_ERR(server->client)) {
506 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
507 return PTR_ERR(server->client);
510 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
511 struct rpc_auth *auth;
513 auth = rpcauth_create(pseudoflavour, server->client);
515 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
516 return PTR_ERR(auth);
519 server->client->cl_softrtry = 0;
520 if (server->flags & NFS_MOUNT_SOFT)
521 server->client->cl_softrtry = 1;
523 server->client->cl_intr = 0;
524 if (server->flags & NFS4_MOUNT_INTR)
525 server->client->cl_intr = 1;
527 server->client->cl_tagxid = (server->flags & NFS_MOUNT_TAGXID) ? 1 : 0;
533 * Initialise an NFS2 or NFS3 client
535 static int nfs_init_client(struct nfs_client *clp, const struct nfs_mount_data *data)
537 int proto = (data->flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
540 if (clp->cl_cons_state == NFS_CS_READY) {
541 /* the client is already initialised */
542 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
546 /* Check NFS protocol revision and initialize RPC op vector */
547 clp->rpc_ops = &nfs_v2_clientops;
549 if (clp->cl_nfsversion == 3)
550 clp->rpc_ops = &nfs_v3_clientops;
553 * Create a client RPC handle for doing FSSTAT with UNIX auth only
554 * - RFC 2623, sec 2.3.2
556 error = nfs_create_rpc_client(clp, proto, data->timeo, data->retrans,
560 nfs_mark_client_ready(clp, NFS_CS_READY);
564 nfs_mark_client_ready(clp, error);
565 dprintk("<-- nfs_init_client() = xerror %d\n", error);
570 * Create a version 2 or 3 client
572 static int nfs_init_server(struct nfs_server *server, const struct nfs_mount_data *data)
574 struct nfs_client *clp;
575 int error, nfsvers = 2;
577 dprintk("--> nfs_init_server()\n");
580 if (data->flags & NFS_MOUNT_VER3)
584 /* Allocate or find a client reference we can use */
585 clp = nfs_get_client(data->hostname, &data->addr, nfsvers);
587 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
591 error = nfs_init_client(clp, data);
595 server->nfs_client = clp;
597 /* Initialise the client representation from the mount data */
598 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
601 server->rsize = nfs_block_size(data->rsize, NULL);
603 server->wsize = nfs_block_size(data->wsize, NULL);
605 server->acregmin = data->acregmin * HZ;
606 server->acregmax = data->acregmax * HZ;
607 server->acdirmin = data->acdirmin * HZ;
608 server->acdirmax = data->acdirmax * HZ;
610 /* Start lockd here, before we might error out */
611 error = nfs_start_lockd(server);
615 error = nfs_init_server_rpcclient(server, data->pseudoflavor);
619 server->namelen = data->namlen;
620 /* Create a client RPC handle for the NFSv3 ACL management interface */
621 nfs_init_server_aclclient(server);
622 if (clp->cl_nfsversion == 3) {
623 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
624 server->namelen = NFS3_MAXNAMLEN;
625 server->caps |= NFS_CAP_READDIRPLUS;
627 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
628 server->namelen = NFS2_MAXNAMLEN;
631 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
635 server->nfs_client = NULL;
637 dprintk("<-- nfs_init_server() = xerror %d\n", error);
642 * Load up the server record from information gained in an fsinfo record
644 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
646 unsigned long max_rpc_payload;
648 /* Work out a lot of parameters */
649 if (server->rsize == 0)
650 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
651 if (server->wsize == 0)
652 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
654 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
655 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
656 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
657 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
659 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
660 if (server->rsize > max_rpc_payload)
661 server->rsize = max_rpc_payload;
662 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
663 server->rsize = NFS_MAX_FILE_IO_SIZE;
664 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
665 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
667 if (server->wsize > max_rpc_payload)
668 server->wsize = max_rpc_payload;
669 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
670 server->wsize = NFS_MAX_FILE_IO_SIZE;
671 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
672 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
674 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
675 if (server->dtsize > PAGE_CACHE_SIZE)
676 server->dtsize = PAGE_CACHE_SIZE;
677 if (server->dtsize > server->rsize)
678 server->dtsize = server->rsize;
680 if (server->flags & NFS_MOUNT_NOAC) {
681 server->acregmin = server->acregmax = 0;
682 server->acdirmin = server->acdirmax = 0;
685 server->maxfilesize = fsinfo->maxfilesize;
687 /* We're airborne Set socket buffersize */
688 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
692 * Probe filesystem information, including the FSID on v2/v3
694 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
696 struct nfs_fsinfo fsinfo;
697 struct nfs_client *clp = server->nfs_client;
700 dprintk("--> nfs_probe_fsinfo()\n");
702 if (clp->rpc_ops->set_capabilities != NULL) {
703 error = clp->rpc_ops->set_capabilities(server, mntfh);
708 fsinfo.fattr = fattr;
709 nfs_fattr_init(fattr);
710 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
714 nfs_server_set_fsinfo(server, &fsinfo);
716 /* Get some general file system info */
717 if (server->namelen == 0) {
718 struct nfs_pathconf pathinfo;
720 pathinfo.fattr = fattr;
721 nfs_fattr_init(fattr);
723 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
724 server->namelen = pathinfo.max_namelen;
727 dprintk("<-- nfs_probe_fsinfo() = 0\n");
731 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
736 * Copy useful information when duplicating a server record
738 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
740 target->flags = source->flags;
741 target->acregmin = source->acregmin;
742 target->acregmax = source->acregmax;
743 target->acdirmin = source->acdirmin;
744 target->acdirmax = source->acdirmax;
745 target->caps = source->caps;
749 * Allocate and initialise a server record
751 static struct nfs_server *nfs_alloc_server(void)
753 struct nfs_server *server;
755 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
759 server->client = server->client_acl = ERR_PTR(-EINVAL);
761 /* Zero out the NFS state stuff */
762 INIT_LIST_HEAD(&server->client_link);
763 INIT_LIST_HEAD(&server->master_link);
765 server->io_stats = nfs_alloc_iostats();
766 if (!server->io_stats) {
775 * Free up a server record
777 void nfs_free_server(struct nfs_server *server)
779 dprintk("--> nfs_free_server()\n");
781 spin_lock(&nfs_client_lock);
782 list_del(&server->client_link);
783 list_del(&server->master_link);
784 spin_unlock(&nfs_client_lock);
786 if (server->destroy != NULL)
787 server->destroy(server);
788 if (!IS_ERR(server->client))
789 rpc_shutdown_client(server->client);
791 nfs_put_client(server->nfs_client);
793 nfs_free_iostats(server->io_stats);
795 nfs_release_automount_timer();
796 dprintk("<-- nfs_free_server()\n");
800 * Create a version 2 or 3 volume record
801 * - keyed on server and FSID
803 struct nfs_server *nfs_create_server(const struct nfs_mount_data *data,
804 struct nfs_fh *mntfh)
806 struct nfs_server *server;
807 struct nfs_fattr fattr;
810 server = nfs_alloc_server();
812 return ERR_PTR(-ENOMEM);
814 /* Get a client representation */
815 error = nfs_init_server(server, data);
819 BUG_ON(!server->nfs_client);
820 BUG_ON(!server->nfs_client->rpc_ops);
821 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
823 /* Probe the root fh to retrieve its FSID */
824 error = nfs_probe_fsinfo(server, mntfh, &fattr);
827 if (!(fattr.valid & NFS_ATTR_FATTR)) {
828 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
830 dprintk("nfs_create_server: getattr error = %d\n", -error);
834 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
836 dprintk("Server FSID: %llx:%llx\n", server->fsid.major, server->fsid.minor);
838 BUG_ON(!server->nfs_client);
839 BUG_ON(!server->nfs_client->rpc_ops);
840 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
842 spin_lock(&nfs_client_lock);
843 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
844 list_add_tail(&server->master_link, &nfs_volume_list);
845 spin_unlock(&nfs_client_lock);
847 server->mount_time = jiffies;
851 nfs_free_server(server);
852 return ERR_PTR(error);
857 * Initialise an NFS4 client record
859 static int nfs4_init_client(struct nfs_client *clp,
860 int proto, int timeo, int retrans,
861 rpc_authflavor_t authflavour)
865 if (clp->cl_cons_state == NFS_CS_READY) {
866 /* the client is initialised already */
867 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
871 /* Check NFS protocol revision and initialize RPC op vector */
872 clp->rpc_ops = &nfs_v4_clientops;
874 error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour);
878 error = nfs_idmap_new(clp);
880 dprintk("%s: failed to create idmapper. Error = %d\n",
881 __FUNCTION__, error);
884 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
886 nfs_mark_client_ready(clp, NFS_CS_READY);
890 nfs_mark_client_ready(clp, error);
891 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
896 * Set up an NFS4 client
898 static int nfs4_set_client(struct nfs_server *server,
899 const char *hostname, const struct sockaddr_in *addr,
900 rpc_authflavor_t authflavour,
901 int proto, int timeo, int retrans)
903 struct nfs_client *clp;
906 dprintk("--> nfs4_set_client()\n");
908 /* Allocate or find a client reference we can use */
909 clp = nfs_get_client(hostname, addr, 4);
911 error = PTR_ERR(clp);
914 error = nfs4_init_client(clp, proto, timeo, retrans, authflavour);
918 server->nfs_client = clp;
919 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
925 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
930 * Create a version 4 volume record
932 static int nfs4_init_server(struct nfs_server *server,
933 const struct nfs4_mount_data *data, rpc_authflavor_t authflavour)
937 dprintk("--> nfs4_init_server()\n");
939 /* Initialise the client representation from the mount data */
940 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
941 server->caps |= NFS_CAP_ATOMIC_OPEN;
944 server->rsize = nfs_block_size(data->rsize, NULL);
946 server->wsize = nfs_block_size(data->wsize, NULL);
948 server->acregmin = data->acregmin * HZ;
949 server->acregmax = data->acregmax * HZ;
950 server->acdirmin = data->acdirmin * HZ;
951 server->acdirmax = data->acdirmax * HZ;
953 error = nfs_init_server_rpcclient(server, authflavour);
956 dprintk("<-- nfs4_init_server() = %d\n", error);
961 * Create a version 4 volume record
962 * - keyed on server and FSID
964 struct nfs_server *nfs4_create_server(const struct nfs4_mount_data *data,
965 const char *hostname,
966 const struct sockaddr_in *addr,
969 rpc_authflavor_t authflavour,
970 struct nfs_fh *mntfh)
972 struct nfs_fattr fattr;
973 struct nfs_server *server;
976 dprintk("--> nfs4_create_server()\n");
978 server = nfs_alloc_server();
980 return ERR_PTR(-ENOMEM);
982 /* Get a client record */
983 error = nfs4_set_client(server, hostname, addr, authflavour,
984 data->proto, data->timeo, data->retrans);
988 /* set up the general RPC client */
989 error = nfs4_init_server(server, data, authflavour);
993 BUG_ON(!server->nfs_client);
994 BUG_ON(!server->nfs_client->rpc_ops);
995 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
997 /* Probe the root fh to retrieve its FSID */
998 error = nfs4_path_walk(server, mntfh, mntpath);
1002 dprintk("Server FSID: %llx:%llx\n", server->fsid.major, server->fsid.minor);
1003 dprintk("Mount FH: %d\n", mntfh->size);
1005 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1009 BUG_ON(!server->nfs_client);
1010 BUG_ON(!server->nfs_client->rpc_ops);
1011 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1013 spin_lock(&nfs_client_lock);
1014 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1015 list_add_tail(&server->master_link, &nfs_volume_list);
1016 spin_unlock(&nfs_client_lock);
1018 server->mount_time = jiffies;
1019 dprintk("<-- nfs4_create_server() = %p\n", server);
1023 nfs_free_server(server);
1024 dprintk("<-- nfs4_create_server() = error %d\n", error);
1025 return ERR_PTR(error);
1029 * Create an NFS4 referral server record
1031 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1034 struct nfs_client *parent_client;
1035 struct nfs_server *server, *parent_server;
1036 struct nfs_fattr fattr;
1039 dprintk("--> nfs4_create_referral_server()\n");
1041 server = nfs_alloc_server();
1043 return ERR_PTR(-ENOMEM);
1045 parent_server = NFS_SB(data->sb);
1046 parent_client = parent_server->nfs_client;
1048 /* Get a client representation.
1049 * Note: NFSv4 always uses TCP, */
1050 error = nfs4_set_client(server, data->hostname, data->addr,
1052 parent_server->client->cl_xprt->prot,
1053 parent_client->retrans_timeo,
1054 parent_client->retrans_count);
1056 /* Initialise the client representation from the parent server */
1057 nfs_server_copy_userdata(server, parent_server);
1058 server->caps |= NFS_CAP_ATOMIC_OPEN;
1060 error = nfs_init_server_rpcclient(server, data->authflavor);
1064 BUG_ON(!server->nfs_client);
1065 BUG_ON(!server->nfs_client->rpc_ops);
1066 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1068 /* probe the filesystem info for this server filesystem */
1069 error = nfs_probe_fsinfo(server, fh, &fattr);
1073 dprintk("Referral FSID: %llx:%llx\n",
1074 server->fsid.major, server->fsid.minor);
1076 spin_lock(&nfs_client_lock);
1077 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1078 list_add_tail(&server->master_link, &nfs_volume_list);
1079 spin_unlock(&nfs_client_lock);
1081 server->mount_time = jiffies;
1083 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1087 nfs_free_server(server);
1088 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1089 return ERR_PTR(error);
1092 #endif /* CONFIG_NFS_V4 */
1095 * Clone an NFS2, NFS3 or NFS4 server record
1097 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1099 struct nfs_fattr *fattr)
1101 struct nfs_server *server;
1102 struct nfs_fattr fattr_fsinfo;
1105 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1106 fattr->fsid.major, fattr->fsid.minor);
1108 server = nfs_alloc_server();
1110 return ERR_PTR(-ENOMEM);
1112 /* Copy data from the source */
1113 server->nfs_client = source->nfs_client;
1114 atomic_inc(&server->nfs_client->cl_count);
1115 nfs_server_copy_userdata(server, source);
1117 server->fsid = fattr->fsid;
1119 error = nfs_init_server_rpcclient(server, source->client->cl_auth->au_flavor);
1121 goto out_free_server;
1122 if (!IS_ERR(source->client_acl))
1123 nfs_init_server_aclclient(server);
1125 /* probe the filesystem info for this server filesystem */
1126 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1128 goto out_free_server;
1130 dprintk("Cloned FSID: %llx:%llx\n",
1131 server->fsid.major, server->fsid.minor);
1133 error = nfs_start_lockd(server);
1135 goto out_free_server;
1137 spin_lock(&nfs_client_lock);
1138 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1139 list_add_tail(&server->master_link, &nfs_volume_list);
1140 spin_unlock(&nfs_client_lock);
1142 server->mount_time = jiffies;
1144 dprintk("<-- nfs_clone_server() = %p\n", server);
1148 nfs_free_server(server);
1149 dprintk("<-- nfs_clone_server() = error %d\n", error);
1150 return ERR_PTR(error);
1153 #ifdef CONFIG_PROC_FS
1154 static struct proc_dir_entry *proc_fs_nfs;
1156 static int nfs_server_list_open(struct inode *inode, struct file *file);
1157 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1158 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1159 static void nfs_server_list_stop(struct seq_file *p, void *v);
1160 static int nfs_server_list_show(struct seq_file *m, void *v);
1162 static struct seq_operations nfs_server_list_ops = {
1163 .start = nfs_server_list_start,
1164 .next = nfs_server_list_next,
1165 .stop = nfs_server_list_stop,
1166 .show = nfs_server_list_show,
1169 static struct file_operations nfs_server_list_fops = {
1170 .open = nfs_server_list_open,
1172 .llseek = seq_lseek,
1173 .release = seq_release,
1176 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1177 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1178 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1179 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1180 static int nfs_volume_list_show(struct seq_file *m, void *v);
1182 static struct seq_operations nfs_volume_list_ops = {
1183 .start = nfs_volume_list_start,
1184 .next = nfs_volume_list_next,
1185 .stop = nfs_volume_list_stop,
1186 .show = nfs_volume_list_show,
1189 static struct file_operations nfs_volume_list_fops = {
1190 .open = nfs_volume_list_open,
1192 .llseek = seq_lseek,
1193 .release = seq_release,
1197 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1200 static int nfs_server_list_open(struct inode *inode, struct file *file)
1205 ret = seq_open(file, &nfs_server_list_ops);
1209 m = file->private_data;
1210 m->private = PDE(inode)->data;
1216 * set up the iterator to start reading from the server list and return the first item
1218 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1220 struct list_head *_p;
1223 /* lock the list against modification */
1224 spin_lock(&nfs_client_lock);
1226 /* allow for the header line */
1228 return SEQ_START_TOKEN;
1231 /* find the n'th element in the list */
1232 list_for_each(_p, &nfs_client_list)
1236 return _p != &nfs_client_list ? _p : NULL;
1240 * move to next server
1242 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1244 struct list_head *_p;
1249 _p = (v == SEQ_START_TOKEN) ? nfs_client_list.next : _p->next;
1251 return _p != &nfs_client_list ? _p : NULL;
1255 * clean up after reading from the transports list
1257 static void nfs_server_list_stop(struct seq_file *p, void *v)
1259 spin_unlock(&nfs_client_lock);
1263 * display a header line followed by a load of call lines
1265 static int nfs_server_list_show(struct seq_file *m, void *v)
1267 struct nfs_client *clp;
1269 /* display header on line 1 */
1270 if (v == SEQ_START_TOKEN) {
1271 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1275 /* display one transport per line on subsequent lines */
1276 clp = list_entry(v, struct nfs_client, cl_share_link);
1278 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %3d %s\n",
1280 NIPQUAD(clp->cl_addr.sin_addr),
1281 ntohs(clp->cl_addr.sin_port),
1282 atomic_read(&clp->cl_count),
1289 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1291 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1296 ret = seq_open(file, &nfs_volume_list_ops);
1300 m = file->private_data;
1301 m->private = PDE(inode)->data;
1307 * set up the iterator to start reading from the volume list and return the first item
1309 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1311 struct list_head *_p;
1314 /* lock the list against modification */
1315 spin_lock(&nfs_client_lock);
1317 /* allow for the header line */
1319 return SEQ_START_TOKEN;
1322 /* find the n'th element in the list */
1323 list_for_each(_p, &nfs_volume_list)
1327 return _p != &nfs_volume_list ? _p : NULL;
1331 * move to next volume
1333 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1335 struct list_head *_p;
1340 _p = (v == SEQ_START_TOKEN) ? nfs_volume_list.next : _p->next;
1342 return _p != &nfs_volume_list ? _p : NULL;
1346 * clean up after reading from the transports list
1348 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1350 spin_unlock(&nfs_client_lock);
1354 * display a header line followed by a load of call lines
1356 static int nfs_volume_list_show(struct seq_file *m, void *v)
1358 struct nfs_server *server;
1359 struct nfs_client *clp;
1360 char dev[8], fsid[17];
1362 /* display header on line 1 */
1363 if (v == SEQ_START_TOKEN) {
1364 seq_puts(m, "NV SERVER PORT DEV FSID FSC\n");
1367 /* display one transport per line on subsequent lines */
1368 server = list_entry(v, struct nfs_server, master_link);
1369 clp = server->nfs_client;
1371 snprintf(dev, 8, "%u:%u",
1372 MAJOR(server->s_dev), MINOR(server->s_dev));
1374 snprintf(fsid, 17, "%llx:%llx",
1375 server->fsid.major, server->fsid.minor);
1377 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %-7s %-17s %s\n",
1379 NIPQUAD(clp->cl_addr.sin_addr),
1380 ntohs(clp->cl_addr.sin_port),
1383 nfs_server_fscache_state(server));
1389 * initialise the /proc/fs/nfsfs/ directory
1391 int __init nfs_fs_proc_init(void)
1393 struct proc_dir_entry *p;
1395 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1399 proc_fs_nfs->owner = THIS_MODULE;
1401 /* a file of servers with which we're dealing */
1402 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1406 p->proc_fops = &nfs_server_list_fops;
1407 p->owner = THIS_MODULE;
1409 /* a file of volumes that we have mounted */
1410 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1414 p->proc_fops = &nfs_volume_list_fops;
1415 p->owner = THIS_MODULE;
1419 remove_proc_entry("servers", proc_fs_nfs);
1421 remove_proc_entry("nfsfs", proc_root_fs);
1427 * clean up the /proc/fs/nfsfs/ directory
1429 void nfs_fs_proc_exit(void)
1431 remove_proc_entry("volumes", proc_fs_nfs);
1432 remove_proc_entry("servers", proc_fs_nfs);
1433 remove_proc_entry("nfsfs", proc_root_fs);
1436 #endif /* CONFIG_PROC_FS */