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/nfs_fs.h>
27 #include <linux/nfs_mount.h>
28 #include <linux/nfs4_mount.h>
29 #include <linux/lockd/bind.h>
30 #include <linux/seq_file.h>
31 #include <linux/mount.h>
32 #include <linux/nfs_idmap.h>
33 #include <linux/vfs.h>
34 #include <linux/inet.h>
35 #include <linux/nfs_xdr.h>
37 #include <asm/system.h>
41 #include "delegation.h"
45 #define NFSDBG_FACILITY NFSDBG_CLIENT
47 static DEFINE_SPINLOCK(nfs_client_lock);
48 static LIST_HEAD(nfs_client_list);
49 static LIST_HEAD(nfs_volume_list);
50 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
55 static struct rpc_version *nfs_version[5] = {
65 struct rpc_program nfs_program = {
67 .number = NFS_PROGRAM,
68 .nrvers = ARRAY_SIZE(nfs_version),
69 .version = nfs_version,
70 .stats = &nfs_rpcstat,
71 .pipe_dir_name = "/nfs",
74 struct rpc_stat nfs_rpcstat = {
75 .program = &nfs_program
79 #ifdef CONFIG_NFS_V3_ACL
80 static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
81 static struct rpc_version * nfsacl_version[] = {
82 [3] = &nfsacl_version3,
85 struct rpc_program nfsacl_program = {
87 .number = NFS_ACL_PROGRAM,
88 .nrvers = ARRAY_SIZE(nfsacl_version),
89 .version = nfsacl_version,
90 .stats = &nfsacl_rpcstat,
92 #endif /* CONFIG_NFS_V3_ACL */
95 * Allocate a shared client record
97 * Since these are allocated/deallocated very rarely, we don't
98 * bother putting them in a slab cache...
100 static struct nfs_client *nfs_alloc_client(const char *hostname,
101 const struct sockaddr_in *addr,
104 struct nfs_client *clp;
106 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
109 if (nfsversion == 4) {
110 if (nfs_callback_up() < 0)
112 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
115 atomic_set(&clp->cl_count, 1);
116 clp->cl_cons_state = NFS_CS_INITING;
118 clp->cl_nfsversion = nfsversion;
119 memcpy(&clp->cl_addr, addr, sizeof(clp->cl_addr));
122 clp->cl_hostname = kstrdup(hostname, GFP_KERNEL);
123 if (!clp->cl_hostname)
127 INIT_LIST_HEAD(&clp->cl_superblocks);
128 clp->cl_rpcclient = ERR_PTR(-EINVAL);
131 init_rwsem(&clp->cl_sem);
132 INIT_LIST_HEAD(&clp->cl_delegations);
133 INIT_LIST_HEAD(&clp->cl_state_owners);
134 spin_lock_init(&clp->cl_lock);
135 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
136 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
137 clp->cl_boot_time = CURRENT_TIME;
138 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
144 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
152 static void nfs4_shutdown_client(struct nfs_client *clp)
155 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
156 nfs4_kill_renewd(clp);
157 BUG_ON(!list_empty(&clp->cl_state_owners));
158 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
159 nfs_idmap_delete(clp);
164 * Destroy a shared client record
166 static void nfs_free_client(struct nfs_client *clp)
168 dprintk("--> nfs_free_client(%d)\n", clp->cl_nfsversion);
170 nfs4_shutdown_client(clp);
172 /* -EIO all pending I/O */
173 if (!IS_ERR(clp->cl_rpcclient))
174 rpc_shutdown_client(clp->cl_rpcclient);
176 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
179 kfree(clp->cl_hostname);
182 dprintk("<-- nfs_free_client()\n");
186 * Release a reference to a shared client record
188 void nfs_put_client(struct nfs_client *clp)
193 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
195 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
196 list_del(&clp->cl_share_link);
197 spin_unlock(&nfs_client_lock);
199 BUG_ON(!list_empty(&clp->cl_superblocks));
201 nfs_free_client(clp);
206 * Find a client by address
207 * - caller must hold nfs_client_lock
209 static struct nfs_client *__nfs_find_client(const struct sockaddr_in *addr, int nfsversion, int match_port)
211 struct nfs_client *clp;
213 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
214 /* Don't match clients that failed to initialise properly */
215 if (clp->cl_cons_state < 0)
218 /* Different NFS versions cannot share the same nfs_client */
219 if (clp->cl_nfsversion != nfsversion)
222 if (memcmp(&clp->cl_addr.sin_addr, &addr->sin_addr,
223 sizeof(clp->cl_addr.sin_addr)) != 0)
226 if (!match_port || clp->cl_addr.sin_port == addr->sin_port)
233 atomic_inc(&clp->cl_count);
238 * Find a client by IP address and protocol version
239 * - returns NULL if no such client
241 struct nfs_client *nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
243 struct nfs_client *clp;
245 spin_lock(&nfs_client_lock);
246 clp = __nfs_find_client(addr, nfsversion, 0);
247 spin_unlock(&nfs_client_lock);
248 if (clp != NULL && clp->cl_cons_state != NFS_CS_READY) {
256 * Look up a client by IP address and protocol version
257 * - creates a new record if one doesn't yet exist
259 static struct nfs_client *nfs_get_client(const char *hostname,
260 const struct sockaddr_in *addr,
263 struct nfs_client *clp, *new = NULL;
266 dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT":%d,%d)\n",
267 hostname ?: "", NIPQUAD(addr->sin_addr),
268 addr->sin_port, nfsversion);
270 /* see if the client already exists */
272 spin_lock(&nfs_client_lock);
274 clp = __nfs_find_client(addr, nfsversion, 1);
280 spin_unlock(&nfs_client_lock);
282 new = nfs_alloc_client(hostname, addr, nfsversion);
285 return ERR_PTR(-ENOMEM);
287 /* install a new client and return with it unready */
290 list_add(&clp->cl_share_link, &nfs_client_list);
291 spin_unlock(&nfs_client_lock);
292 dprintk("--> nfs_get_client() = %p [new]\n", clp);
295 /* found an existing client
296 * - make sure it's ready before returning
299 spin_unlock(&nfs_client_lock);
302 nfs_free_client(new);
304 error = wait_event_interruptible(nfs_client_active_wq,
305 clp->cl_cons_state != NFS_CS_INITING);
308 return ERR_PTR(-ERESTARTSYS);
311 if (clp->cl_cons_state < NFS_CS_READY) {
312 error = clp->cl_cons_state;
314 return ERR_PTR(error);
317 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
319 dprintk("--> nfs_get_client() = %p [share]\n", clp);
324 * Mark a server as ready or failed
326 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
328 clp->cl_cons_state = state;
329 wake_up_all(&nfs_client_active_wq);
333 * Initialise the timeout values for a connection
335 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
336 unsigned int timeo, unsigned int retrans)
338 to->to_initval = timeo * HZ / 10;
339 to->to_retries = retrans;
346 to->to_initval = 60 * HZ;
347 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
348 to->to_initval = NFS_MAX_TCP_TIMEOUT;
349 to->to_increment = to->to_initval;
350 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
351 to->to_exponential = 0;
356 to->to_initval = 11 * HZ / 10;
357 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
358 to->to_initval = NFS_MAX_UDP_TIMEOUT;
359 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
360 to->to_exponential = 1;
366 * Create an RPC client handle
368 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
370 unsigned int retrans,
371 rpc_authflavor_t flavor,
374 struct rpc_timeout timeparms;
375 struct rpc_clnt *clnt = NULL;
376 struct rpc_create_args args = {
378 .address = (struct sockaddr *)&clp->cl_addr,
379 .addrsize = sizeof(clp->cl_addr),
380 .timeout = &timeparms,
381 .servername = clp->cl_hostname,
382 .program = &nfs_program,
383 .version = clp->rpc_ops->version,
384 .authflavor = flavor,
388 if (!IS_ERR(clp->cl_rpcclient))
391 nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
392 clp->retrans_timeo = timeparms.to_initval;
393 clp->retrans_count = timeparms.to_retries;
395 clnt = rpc_create(&args);
397 dprintk("%s: cannot create RPC client. Error = %ld\n",
398 __FUNCTION__, PTR_ERR(clnt));
399 return PTR_ERR(clnt);
402 clp->cl_rpcclient = clnt;
407 * Version 2 or 3 client destruction
409 static void nfs_destroy_server(struct nfs_server *server)
411 if (!IS_ERR(server->client_acl))
412 rpc_shutdown_client(server->client_acl);
414 if (!(server->flags & NFS_MOUNT_NONLM))
415 lockd_down(); /* release rpc.lockd */
419 * Version 2 or 3 lockd setup
421 static int nfs_start_lockd(struct nfs_server *server)
425 if (server->nfs_client->cl_nfsversion > 3)
427 if (server->flags & NFS_MOUNT_NONLM)
429 error = lockd_up((server->flags & NFS_MOUNT_TCP) ?
430 IPPROTO_TCP : IPPROTO_UDP);
432 server->flags |= NFS_MOUNT_NONLM;
434 server->destroy = nfs_destroy_server;
440 * Initialise an NFSv3 ACL client connection
442 #ifdef CONFIG_NFS_V3_ACL
443 static void nfs_init_server_aclclient(struct nfs_server *server)
445 if (server->nfs_client->cl_nfsversion != 3)
447 if (server->flags & NFS_MOUNT_NOACL)
450 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
451 if (IS_ERR(server->client_acl))
454 /* No errors! Assume that Sun nfsacls are supported */
455 server->caps |= NFS_CAP_ACLS;
459 server->caps &= ~NFS_CAP_ACLS;
462 static inline void nfs_init_server_aclclient(struct nfs_server *server)
464 server->flags &= ~NFS_MOUNT_NOACL;
465 server->caps &= ~NFS_CAP_ACLS;
470 * Create a general RPC client
472 static int nfs_init_server_rpcclient(struct nfs_server *server, rpc_authflavor_t pseudoflavour)
474 struct nfs_client *clp = server->nfs_client;
476 server->client = rpc_clone_client(clp->cl_rpcclient);
477 if (IS_ERR(server->client)) {
478 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
479 return PTR_ERR(server->client);
482 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
483 struct rpc_auth *auth;
485 auth = rpcauth_create(pseudoflavour, server->client);
487 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
488 return PTR_ERR(auth);
491 server->client->cl_softrtry = 0;
492 if (server->flags & NFS_MOUNT_SOFT)
493 server->client->cl_softrtry = 1;
495 server->client->cl_intr = 0;
496 if (server->flags & NFS4_MOUNT_INTR)
497 server->client->cl_intr = 1;
503 * Initialise an NFS2 or NFS3 client
505 static int nfs_init_client(struct nfs_client *clp, const struct nfs_mount_data *data)
507 int proto = (data->flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
510 if (clp->cl_cons_state == NFS_CS_READY) {
511 /* the client is already initialised */
512 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
516 /* Check NFS protocol revision and initialize RPC op vector */
517 clp->rpc_ops = &nfs_v2_clientops;
519 if (clp->cl_nfsversion == 3)
520 clp->rpc_ops = &nfs_v3_clientops;
523 * Create a client RPC handle for doing FSSTAT with UNIX auth only
524 * - RFC 2623, sec 2.3.2
526 error = nfs_create_rpc_client(clp, proto, data->timeo, data->retrans,
530 nfs_mark_client_ready(clp, NFS_CS_READY);
534 nfs_mark_client_ready(clp, error);
535 dprintk("<-- nfs_init_client() = xerror %d\n", error);
540 * Create a version 2 or 3 client
542 static int nfs_init_server(struct nfs_server *server, const struct nfs_mount_data *data)
544 struct nfs_client *clp;
545 int error, nfsvers = 2;
547 dprintk("--> nfs_init_server()\n");
550 if (data->flags & NFS_MOUNT_VER3)
554 /* Allocate or find a client reference we can use */
555 clp = nfs_get_client(data->hostname, &data->addr, nfsvers);
557 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
561 error = nfs_init_client(clp, data);
565 server->nfs_client = clp;
567 /* Initialise the client representation from the mount data */
568 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
571 server->rsize = nfs_block_size(data->rsize, NULL);
573 server->wsize = nfs_block_size(data->wsize, NULL);
575 server->acregmin = data->acregmin * HZ;
576 server->acregmax = data->acregmax * HZ;
577 server->acdirmin = data->acdirmin * HZ;
578 server->acdirmax = data->acdirmax * HZ;
580 /* Start lockd here, before we might error out */
581 error = nfs_start_lockd(server);
585 error = nfs_init_server_rpcclient(server, data->pseudoflavor);
589 server->namelen = data->namlen;
590 /* Create a client RPC handle for the NFSv3 ACL management interface */
591 nfs_init_server_aclclient(server);
592 if (clp->cl_nfsversion == 3) {
593 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
594 server->namelen = NFS3_MAXNAMLEN;
595 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
596 server->caps |= NFS_CAP_READDIRPLUS;
598 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
599 server->namelen = NFS2_MAXNAMLEN;
602 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
606 server->nfs_client = NULL;
608 dprintk("<-- nfs_init_server() = xerror %d\n", error);
613 * Load up the server record from information gained in an fsinfo record
615 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
617 unsigned long max_rpc_payload;
619 /* Work out a lot of parameters */
620 if (server->rsize == 0)
621 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
622 if (server->wsize == 0)
623 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
625 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
626 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
627 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
628 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
630 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
631 if (server->rsize > max_rpc_payload)
632 server->rsize = max_rpc_payload;
633 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
634 server->rsize = NFS_MAX_FILE_IO_SIZE;
635 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
636 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
638 if (server->wsize > max_rpc_payload)
639 server->wsize = max_rpc_payload;
640 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
641 server->wsize = NFS_MAX_FILE_IO_SIZE;
642 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
643 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
645 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
646 if (server->dtsize > PAGE_CACHE_SIZE)
647 server->dtsize = PAGE_CACHE_SIZE;
648 if (server->dtsize > server->rsize)
649 server->dtsize = server->rsize;
651 if (server->flags & NFS_MOUNT_NOAC) {
652 server->acregmin = server->acregmax = 0;
653 server->acdirmin = server->acdirmax = 0;
656 server->maxfilesize = fsinfo->maxfilesize;
658 /* We're airborne Set socket buffersize */
659 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
663 * Probe filesystem information, including the FSID on v2/v3
665 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
667 struct nfs_fsinfo fsinfo;
668 struct nfs_client *clp = server->nfs_client;
671 dprintk("--> nfs_probe_fsinfo()\n");
673 if (clp->rpc_ops->set_capabilities != NULL) {
674 error = clp->rpc_ops->set_capabilities(server, mntfh);
679 fsinfo.fattr = fattr;
680 nfs_fattr_init(fattr);
681 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
685 nfs_server_set_fsinfo(server, &fsinfo);
687 /* Get some general file system info */
688 if (server->namelen == 0) {
689 struct nfs_pathconf pathinfo;
691 pathinfo.fattr = fattr;
692 nfs_fattr_init(fattr);
694 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
695 server->namelen = pathinfo.max_namelen;
698 dprintk("<-- nfs_probe_fsinfo() = 0\n");
702 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
707 * Copy useful information when duplicating a server record
709 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
711 target->flags = source->flags;
712 target->acregmin = source->acregmin;
713 target->acregmax = source->acregmax;
714 target->acdirmin = source->acdirmin;
715 target->acdirmax = source->acdirmax;
716 target->caps = source->caps;
720 * Allocate and initialise a server record
722 static struct nfs_server *nfs_alloc_server(void)
724 struct nfs_server *server;
726 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
730 server->client = server->client_acl = ERR_PTR(-EINVAL);
732 /* Zero out the NFS state stuff */
733 INIT_LIST_HEAD(&server->client_link);
734 INIT_LIST_HEAD(&server->master_link);
736 server->io_stats = nfs_alloc_iostats();
737 if (!server->io_stats) {
746 * Free up a server record
748 void nfs_free_server(struct nfs_server *server)
750 dprintk("--> nfs_free_server()\n");
752 spin_lock(&nfs_client_lock);
753 list_del(&server->client_link);
754 list_del(&server->master_link);
755 spin_unlock(&nfs_client_lock);
757 if (server->destroy != NULL)
758 server->destroy(server);
759 if (!IS_ERR(server->client))
760 rpc_shutdown_client(server->client);
762 nfs_put_client(server->nfs_client);
764 nfs_free_iostats(server->io_stats);
766 nfs_release_automount_timer();
767 dprintk("<-- nfs_free_server()\n");
771 * Create a version 2 or 3 volume record
772 * - keyed on server and FSID
774 struct nfs_server *nfs_create_server(const struct nfs_mount_data *data,
775 struct nfs_fh *mntfh)
777 struct nfs_server *server;
778 struct nfs_fattr fattr;
781 server = nfs_alloc_server();
783 return ERR_PTR(-ENOMEM);
785 /* Get a client representation */
786 error = nfs_init_server(server, data);
790 BUG_ON(!server->nfs_client);
791 BUG_ON(!server->nfs_client->rpc_ops);
792 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
794 /* Probe the root fh to retrieve its FSID */
795 error = nfs_probe_fsinfo(server, mntfh, &fattr);
798 if (!(fattr.valid & NFS_ATTR_FATTR)) {
799 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
801 dprintk("nfs_create_server: getattr error = %d\n", -error);
805 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
807 dprintk("Server FSID: %llx:%llx\n",
808 (unsigned long long) server->fsid.major,
809 (unsigned long long) server->fsid.minor);
811 BUG_ON(!server->nfs_client);
812 BUG_ON(!server->nfs_client->rpc_ops);
813 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
815 spin_lock(&nfs_client_lock);
816 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
817 list_add_tail(&server->master_link, &nfs_volume_list);
818 spin_unlock(&nfs_client_lock);
820 server->mount_time = jiffies;
824 nfs_free_server(server);
825 return ERR_PTR(error);
830 * Initialise an NFS4 client record
832 static int nfs4_init_client(struct nfs_client *clp,
833 int proto, int timeo, int retrans,
835 rpc_authflavor_t authflavour)
839 if (clp->cl_cons_state == NFS_CS_READY) {
840 /* the client is initialised already */
841 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
845 /* Check NFS protocol revision and initialize RPC op vector */
846 clp->rpc_ops = &nfs_v4_clientops;
848 error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour,
849 RPC_CLNT_CREATE_DISCRTRY);
852 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
854 error = nfs_idmap_new(clp);
856 dprintk("%s: failed to create idmapper. Error = %d\n",
857 __FUNCTION__, error);
860 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
862 nfs_mark_client_ready(clp, NFS_CS_READY);
866 nfs_mark_client_ready(clp, error);
867 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
872 * Set up an NFS4 client
874 static int nfs4_set_client(struct nfs_server *server,
875 const char *hostname, const struct sockaddr_in *addr,
877 rpc_authflavor_t authflavour,
878 int proto, int timeo, int retrans)
880 struct nfs_client *clp;
883 dprintk("--> nfs4_set_client()\n");
885 /* Allocate or find a client reference we can use */
886 clp = nfs_get_client(hostname, addr, 4);
888 error = PTR_ERR(clp);
891 error = nfs4_init_client(clp, proto, timeo, retrans, ip_addr, authflavour);
895 server->nfs_client = clp;
896 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
902 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
907 * Create a version 4 volume record
909 static int nfs4_init_server(struct nfs_server *server,
910 const struct nfs4_mount_data *data, rpc_authflavor_t authflavour)
914 dprintk("--> nfs4_init_server()\n");
916 /* Initialise the client representation from the mount data */
917 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
918 server->caps |= NFS_CAP_ATOMIC_OPEN;
921 server->rsize = nfs_block_size(data->rsize, NULL);
923 server->wsize = nfs_block_size(data->wsize, NULL);
925 server->acregmin = data->acregmin * HZ;
926 server->acregmax = data->acregmax * HZ;
927 server->acdirmin = data->acdirmin * HZ;
928 server->acdirmax = data->acdirmax * HZ;
930 error = nfs_init_server_rpcclient(server, authflavour);
933 dprintk("<-- nfs4_init_server() = %d\n", error);
938 * Create a version 4 volume record
939 * - keyed on server and FSID
941 struct nfs_server *nfs4_create_server(const struct nfs4_mount_data *data,
942 const char *hostname,
943 const struct sockaddr_in *addr,
946 rpc_authflavor_t authflavour,
947 struct nfs_fh *mntfh)
949 struct nfs_fattr fattr;
950 struct nfs_server *server;
953 dprintk("--> nfs4_create_server()\n");
955 server = nfs_alloc_server();
957 return ERR_PTR(-ENOMEM);
959 /* Get a client record */
960 error = nfs4_set_client(server, hostname, addr, ip_addr, authflavour,
961 data->proto, data->timeo, data->retrans);
965 /* set up the general RPC client */
966 error = nfs4_init_server(server, data, authflavour);
970 BUG_ON(!server->nfs_client);
971 BUG_ON(!server->nfs_client->rpc_ops);
972 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
974 /* Probe the root fh to retrieve its FSID */
975 error = nfs4_path_walk(server, mntfh, mntpath);
979 dprintk("Server FSID: %llx:%llx\n",
980 (unsigned long long) server->fsid.major,
981 (unsigned long long) server->fsid.minor);
982 dprintk("Mount FH: %d\n", mntfh->size);
984 error = nfs_probe_fsinfo(server, mntfh, &fattr);
988 BUG_ON(!server->nfs_client);
989 BUG_ON(!server->nfs_client->rpc_ops);
990 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
992 spin_lock(&nfs_client_lock);
993 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
994 list_add_tail(&server->master_link, &nfs_volume_list);
995 spin_unlock(&nfs_client_lock);
997 server->mount_time = jiffies;
998 dprintk("<-- nfs4_create_server() = %p\n", server);
1002 nfs_free_server(server);
1003 dprintk("<-- nfs4_create_server() = error %d\n", error);
1004 return ERR_PTR(error);
1008 * Create an NFS4 referral server record
1010 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1011 struct nfs_fh *mntfh)
1013 struct nfs_client *parent_client;
1014 struct nfs_server *server, *parent_server;
1015 struct nfs_fattr fattr;
1018 dprintk("--> nfs4_create_referral_server()\n");
1020 server = nfs_alloc_server();
1022 return ERR_PTR(-ENOMEM);
1024 parent_server = NFS_SB(data->sb);
1025 parent_client = parent_server->nfs_client;
1027 /* Get a client representation.
1028 * Note: NFSv4 always uses TCP, */
1029 error = nfs4_set_client(server, data->hostname, data->addr,
1030 parent_client->cl_ipaddr,
1032 parent_server->client->cl_xprt->prot,
1033 parent_client->retrans_timeo,
1034 parent_client->retrans_count);
1038 /* Initialise the client representation from the parent server */
1039 nfs_server_copy_userdata(server, parent_server);
1040 server->caps |= NFS_CAP_ATOMIC_OPEN;
1042 error = nfs_init_server_rpcclient(server, data->authflavor);
1046 BUG_ON(!server->nfs_client);
1047 BUG_ON(!server->nfs_client->rpc_ops);
1048 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1050 /* Probe the root fh to retrieve its FSID and filehandle */
1051 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1055 /* probe the filesystem info for this server filesystem */
1056 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1060 dprintk("Referral FSID: %llx:%llx\n",
1061 (unsigned long long) server->fsid.major,
1062 (unsigned long long) server->fsid.minor);
1064 spin_lock(&nfs_client_lock);
1065 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1066 list_add_tail(&server->master_link, &nfs_volume_list);
1067 spin_unlock(&nfs_client_lock);
1069 server->mount_time = jiffies;
1071 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1075 nfs_free_server(server);
1076 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1077 return ERR_PTR(error);
1080 #endif /* CONFIG_NFS_V4 */
1083 * Clone an NFS2, NFS3 or NFS4 server record
1085 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1087 struct nfs_fattr *fattr)
1089 struct nfs_server *server;
1090 struct nfs_fattr fattr_fsinfo;
1093 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1094 (unsigned long long) fattr->fsid.major,
1095 (unsigned long long) fattr->fsid.minor);
1097 server = nfs_alloc_server();
1099 return ERR_PTR(-ENOMEM);
1101 /* Copy data from the source */
1102 server->nfs_client = source->nfs_client;
1103 atomic_inc(&server->nfs_client->cl_count);
1104 nfs_server_copy_userdata(server, source);
1106 server->fsid = fattr->fsid;
1108 error = nfs_init_server_rpcclient(server, source->client->cl_auth->au_flavor);
1110 goto out_free_server;
1111 if (!IS_ERR(source->client_acl))
1112 nfs_init_server_aclclient(server);
1114 /* probe the filesystem info for this server filesystem */
1115 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1117 goto out_free_server;
1119 dprintk("Cloned FSID: %llx:%llx\n",
1120 (unsigned long long) server->fsid.major,
1121 (unsigned long long) server->fsid.minor);
1123 error = nfs_start_lockd(server);
1125 goto out_free_server;
1127 spin_lock(&nfs_client_lock);
1128 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1129 list_add_tail(&server->master_link, &nfs_volume_list);
1130 spin_unlock(&nfs_client_lock);
1132 server->mount_time = jiffies;
1134 dprintk("<-- nfs_clone_server() = %p\n", server);
1138 nfs_free_server(server);
1139 dprintk("<-- nfs_clone_server() = error %d\n", error);
1140 return ERR_PTR(error);
1143 #ifdef CONFIG_PROC_FS
1144 static struct proc_dir_entry *proc_fs_nfs;
1146 static int nfs_server_list_open(struct inode *inode, struct file *file);
1147 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1148 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1149 static void nfs_server_list_stop(struct seq_file *p, void *v);
1150 static int nfs_server_list_show(struct seq_file *m, void *v);
1152 static struct seq_operations nfs_server_list_ops = {
1153 .start = nfs_server_list_start,
1154 .next = nfs_server_list_next,
1155 .stop = nfs_server_list_stop,
1156 .show = nfs_server_list_show,
1159 static const struct file_operations nfs_server_list_fops = {
1160 .open = nfs_server_list_open,
1162 .llseek = seq_lseek,
1163 .release = seq_release,
1166 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1167 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1168 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1169 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1170 static int nfs_volume_list_show(struct seq_file *m, void *v);
1172 static struct seq_operations nfs_volume_list_ops = {
1173 .start = nfs_volume_list_start,
1174 .next = nfs_volume_list_next,
1175 .stop = nfs_volume_list_stop,
1176 .show = nfs_volume_list_show,
1179 static const struct file_operations nfs_volume_list_fops = {
1180 .open = nfs_volume_list_open,
1182 .llseek = seq_lseek,
1183 .release = seq_release,
1187 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1190 static int nfs_server_list_open(struct inode *inode, struct file *file)
1195 ret = seq_open(file, &nfs_server_list_ops);
1199 m = file->private_data;
1200 m->private = PDE(inode)->data;
1206 * set up the iterator to start reading from the server list and return the first item
1208 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1210 struct list_head *_p;
1213 /* lock the list against modification */
1214 spin_lock(&nfs_client_lock);
1216 /* allow for the header line */
1218 return SEQ_START_TOKEN;
1221 /* find the n'th element in the list */
1222 list_for_each(_p, &nfs_client_list)
1226 return _p != &nfs_client_list ? _p : NULL;
1230 * move to next server
1232 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1234 struct list_head *_p;
1239 _p = (v == SEQ_START_TOKEN) ? nfs_client_list.next : _p->next;
1241 return _p != &nfs_client_list ? _p : NULL;
1245 * clean up after reading from the transports list
1247 static void nfs_server_list_stop(struct seq_file *p, void *v)
1249 spin_unlock(&nfs_client_lock);
1253 * display a header line followed by a load of call lines
1255 static int nfs_server_list_show(struct seq_file *m, void *v)
1257 struct nfs_client *clp;
1259 /* display header on line 1 */
1260 if (v == SEQ_START_TOKEN) {
1261 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1265 /* display one transport per line on subsequent lines */
1266 clp = list_entry(v, struct nfs_client, cl_share_link);
1268 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %3d %s\n",
1270 NIPQUAD(clp->cl_addr.sin_addr),
1271 ntohs(clp->cl_addr.sin_port),
1272 atomic_read(&clp->cl_count),
1279 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1281 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1286 ret = seq_open(file, &nfs_volume_list_ops);
1290 m = file->private_data;
1291 m->private = PDE(inode)->data;
1297 * set up the iterator to start reading from the volume list and return the first item
1299 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1301 struct list_head *_p;
1304 /* lock the list against modification */
1305 spin_lock(&nfs_client_lock);
1307 /* allow for the header line */
1309 return SEQ_START_TOKEN;
1312 /* find the n'th element in the list */
1313 list_for_each(_p, &nfs_volume_list)
1317 return _p != &nfs_volume_list ? _p : NULL;
1321 * move to next volume
1323 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1325 struct list_head *_p;
1330 _p = (v == SEQ_START_TOKEN) ? nfs_volume_list.next : _p->next;
1332 return _p != &nfs_volume_list ? _p : NULL;
1336 * clean up after reading from the transports list
1338 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1340 spin_unlock(&nfs_client_lock);
1344 * display a header line followed by a load of call lines
1346 static int nfs_volume_list_show(struct seq_file *m, void *v)
1348 struct nfs_server *server;
1349 struct nfs_client *clp;
1350 char dev[8], fsid[17];
1352 /* display header on line 1 */
1353 if (v == SEQ_START_TOKEN) {
1354 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1357 /* display one transport per line on subsequent lines */
1358 server = list_entry(v, struct nfs_server, master_link);
1359 clp = server->nfs_client;
1361 snprintf(dev, 8, "%u:%u",
1362 MAJOR(server->s_dev), MINOR(server->s_dev));
1364 snprintf(fsid, 17, "%llx:%llx",
1365 (unsigned long long) server->fsid.major,
1366 (unsigned long long) server->fsid.minor);
1368 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %-7s %-17s\n",
1370 NIPQUAD(clp->cl_addr.sin_addr),
1371 ntohs(clp->cl_addr.sin_port),
1379 * initialise the /proc/fs/nfsfs/ directory
1381 int __init nfs_fs_proc_init(void)
1383 struct proc_dir_entry *p;
1385 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1389 proc_fs_nfs->owner = THIS_MODULE;
1391 /* a file of servers with which we're dealing */
1392 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1396 p->proc_fops = &nfs_server_list_fops;
1397 p->owner = THIS_MODULE;
1399 /* a file of volumes that we have mounted */
1400 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1404 p->proc_fops = &nfs_volume_list_fops;
1405 p->owner = THIS_MODULE;
1409 remove_proc_entry("servers", proc_fs_nfs);
1411 remove_proc_entry("nfsfs", proc_root_fs);
1417 * clean up the /proc/fs/nfsfs/ directory
1419 void nfs_fs_proc_exit(void)
1421 remove_proc_entry("volumes", proc_fs_nfs);
1422 remove_proc_entry("servers", proc_fs_nfs);
1423 remove_proc_entry("nfsfs", proc_root_fs);
1426 #endif /* CONFIG_PROC_FS */