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 INIT_LIST_HEAD(&clp->cl_unused);
135 spin_lock_init(&clp->cl_lock);
136 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
137 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
138 clp->cl_boot_time = CURRENT_TIME;
139 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
145 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
153 static void nfs4_shutdown_client(struct nfs_client *clp)
156 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
157 nfs4_kill_renewd(clp);
158 while (!list_empty(&clp->cl_unused)) {
159 struct nfs4_state_owner *sp;
161 sp = list_entry(clp->cl_unused.next,
162 struct nfs4_state_owner,
164 list_del(&sp->so_list);
167 BUG_ON(!list_empty(&clp->cl_state_owners));
168 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
169 nfs_idmap_delete(clp);
174 * Destroy a shared client record
176 static void nfs_free_client(struct nfs_client *clp)
178 dprintk("--> nfs_free_client(%d)\n", clp->cl_nfsversion);
180 nfs4_shutdown_client(clp);
182 /* -EIO all pending I/O */
183 if (!IS_ERR(clp->cl_rpcclient))
184 rpc_shutdown_client(clp->cl_rpcclient);
186 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
189 kfree(clp->cl_hostname);
192 dprintk("<-- nfs_free_client()\n");
196 * Release a reference to a shared client record
198 void nfs_put_client(struct nfs_client *clp)
203 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
205 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
206 list_del(&clp->cl_share_link);
207 spin_unlock(&nfs_client_lock);
209 BUG_ON(!list_empty(&clp->cl_superblocks));
211 nfs_free_client(clp);
216 * Find a client by address
217 * - caller must hold nfs_client_lock
219 static struct nfs_client *__nfs_find_client(const struct sockaddr_in *addr, int nfsversion, int match_port)
221 struct nfs_client *clp;
223 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
224 /* Don't match clients that failed to initialise properly */
225 if (clp->cl_cons_state < 0)
228 /* Different NFS versions cannot share the same nfs_client */
229 if (clp->cl_nfsversion != nfsversion)
232 if (memcmp(&clp->cl_addr.sin_addr, &addr->sin_addr,
233 sizeof(clp->cl_addr.sin_addr)) != 0)
236 if (!match_port || clp->cl_addr.sin_port == addr->sin_port)
243 atomic_inc(&clp->cl_count);
248 * Find a client by IP address and protocol version
249 * - returns NULL if no such client
251 struct nfs_client *nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
253 struct nfs_client *clp;
255 spin_lock(&nfs_client_lock);
256 clp = __nfs_find_client(addr, nfsversion, 0);
257 spin_unlock(&nfs_client_lock);
258 if (clp != NULL && clp->cl_cons_state != NFS_CS_READY) {
266 * Look up a client by IP address and protocol version
267 * - creates a new record if one doesn't yet exist
269 static struct nfs_client *nfs_get_client(const char *hostname,
270 const struct sockaddr_in *addr,
273 struct nfs_client *clp, *new = NULL;
276 dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT":%d,%d)\n",
277 hostname ?: "", NIPQUAD(addr->sin_addr),
278 addr->sin_port, nfsversion);
280 /* see if the client already exists */
282 spin_lock(&nfs_client_lock);
284 clp = __nfs_find_client(addr, nfsversion, 1);
290 spin_unlock(&nfs_client_lock);
292 new = nfs_alloc_client(hostname, addr, nfsversion);
295 return ERR_PTR(-ENOMEM);
297 /* install a new client and return with it unready */
300 list_add(&clp->cl_share_link, &nfs_client_list);
301 spin_unlock(&nfs_client_lock);
302 dprintk("--> nfs_get_client() = %p [new]\n", clp);
305 /* found an existing client
306 * - make sure it's ready before returning
309 spin_unlock(&nfs_client_lock);
312 nfs_free_client(new);
314 error = wait_event_interruptible(nfs_client_active_wq,
315 clp->cl_cons_state != NFS_CS_INITING);
318 return ERR_PTR(-ERESTARTSYS);
321 if (clp->cl_cons_state < NFS_CS_READY) {
322 error = clp->cl_cons_state;
324 return ERR_PTR(error);
327 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
329 dprintk("--> nfs_get_client() = %p [share]\n", clp);
334 * Mark a server as ready or failed
336 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
338 clp->cl_cons_state = state;
339 wake_up_all(&nfs_client_active_wq);
343 * Initialise the timeout values for a connection
345 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
346 unsigned int timeo, unsigned int retrans)
348 to->to_initval = timeo * HZ / 10;
349 to->to_retries = retrans;
356 to->to_initval = 60 * HZ;
357 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
358 to->to_initval = NFS_MAX_TCP_TIMEOUT;
359 to->to_increment = to->to_initval;
360 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
361 to->to_exponential = 0;
366 to->to_initval = 11 * HZ / 10;
367 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
368 to->to_initval = NFS_MAX_UDP_TIMEOUT;
369 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
370 to->to_exponential = 1;
376 * Create an RPC client handle
378 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
380 unsigned int retrans,
381 rpc_authflavor_t flavor,
384 struct rpc_timeout timeparms;
385 struct rpc_clnt *clnt = NULL;
386 struct rpc_create_args args = {
388 .address = (struct sockaddr *)&clp->cl_addr,
389 .addrsize = sizeof(clp->cl_addr),
390 .timeout = &timeparms,
391 .servername = clp->cl_hostname,
392 .program = &nfs_program,
393 .version = clp->rpc_ops->version,
394 .authflavor = flavor,
398 if (!IS_ERR(clp->cl_rpcclient))
401 nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
402 clp->retrans_timeo = timeparms.to_initval;
403 clp->retrans_count = timeparms.to_retries;
405 clnt = rpc_create(&args);
407 dprintk("%s: cannot create RPC client. Error = %ld\n",
408 __FUNCTION__, PTR_ERR(clnt));
409 return PTR_ERR(clnt);
412 clp->cl_rpcclient = clnt;
417 * Version 2 or 3 client destruction
419 static void nfs_destroy_server(struct nfs_server *server)
421 if (!IS_ERR(server->client_acl))
422 rpc_shutdown_client(server->client_acl);
424 if (!(server->flags & NFS_MOUNT_NONLM))
425 lockd_down(); /* release rpc.lockd */
429 * Version 2 or 3 lockd setup
431 static int nfs_start_lockd(struct nfs_server *server)
435 if (server->nfs_client->cl_nfsversion > 3)
437 if (server->flags & NFS_MOUNT_NONLM)
439 error = lockd_up((server->flags & NFS_MOUNT_TCP) ?
440 IPPROTO_TCP : IPPROTO_UDP);
442 server->flags |= NFS_MOUNT_NONLM;
444 server->destroy = nfs_destroy_server;
450 * Initialise an NFSv3 ACL client connection
452 #ifdef CONFIG_NFS_V3_ACL
453 static void nfs_init_server_aclclient(struct nfs_server *server)
455 if (server->nfs_client->cl_nfsversion != 3)
457 if (server->flags & NFS_MOUNT_NOACL)
460 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
461 if (IS_ERR(server->client_acl))
464 /* No errors! Assume that Sun nfsacls are supported */
465 server->caps |= NFS_CAP_ACLS;
469 server->caps &= ~NFS_CAP_ACLS;
472 static inline void nfs_init_server_aclclient(struct nfs_server *server)
474 server->flags &= ~NFS_MOUNT_NOACL;
475 server->caps &= ~NFS_CAP_ACLS;
480 * Create a general RPC client
482 static int nfs_init_server_rpcclient(struct nfs_server *server, rpc_authflavor_t pseudoflavour)
484 struct nfs_client *clp = server->nfs_client;
486 server->client = rpc_clone_client(clp->cl_rpcclient);
487 if (IS_ERR(server->client)) {
488 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
489 return PTR_ERR(server->client);
492 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
493 struct rpc_auth *auth;
495 auth = rpcauth_create(pseudoflavour, server->client);
497 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
498 return PTR_ERR(auth);
501 server->client->cl_softrtry = 0;
502 if (server->flags & NFS_MOUNT_SOFT)
503 server->client->cl_softrtry = 1;
505 server->client->cl_intr = 0;
506 if (server->flags & NFS4_MOUNT_INTR)
507 server->client->cl_intr = 1;
513 * Initialise an NFS2 or NFS3 client
515 static int nfs_init_client(struct nfs_client *clp, const struct nfs_mount_data *data)
517 int proto = (data->flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
520 if (clp->cl_cons_state == NFS_CS_READY) {
521 /* the client is already initialised */
522 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
526 /* Check NFS protocol revision and initialize RPC op vector */
527 clp->rpc_ops = &nfs_v2_clientops;
529 if (clp->cl_nfsversion == 3)
530 clp->rpc_ops = &nfs_v3_clientops;
533 * Create a client RPC handle for doing FSSTAT with UNIX auth only
534 * - RFC 2623, sec 2.3.2
536 error = nfs_create_rpc_client(clp, proto, data->timeo, data->retrans,
540 nfs_mark_client_ready(clp, NFS_CS_READY);
544 nfs_mark_client_ready(clp, error);
545 dprintk("<-- nfs_init_client() = xerror %d\n", error);
550 * Create a version 2 or 3 client
552 static int nfs_init_server(struct nfs_server *server, const struct nfs_mount_data *data)
554 struct nfs_client *clp;
555 int error, nfsvers = 2;
557 dprintk("--> nfs_init_server()\n");
560 if (data->flags & NFS_MOUNT_VER3)
564 /* Allocate or find a client reference we can use */
565 clp = nfs_get_client(data->hostname, &data->addr, nfsvers);
567 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
571 error = nfs_init_client(clp, data);
575 server->nfs_client = clp;
577 /* Initialise the client representation from the mount data */
578 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
581 server->rsize = nfs_block_size(data->rsize, NULL);
583 server->wsize = nfs_block_size(data->wsize, NULL);
585 server->acregmin = data->acregmin * HZ;
586 server->acregmax = data->acregmax * HZ;
587 server->acdirmin = data->acdirmin * HZ;
588 server->acdirmax = data->acdirmax * HZ;
590 /* Start lockd here, before we might error out */
591 error = nfs_start_lockd(server);
595 error = nfs_init_server_rpcclient(server, data->pseudoflavor);
599 server->namelen = data->namlen;
600 /* Create a client RPC handle for the NFSv3 ACL management interface */
601 nfs_init_server_aclclient(server);
602 if (clp->cl_nfsversion == 3) {
603 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
604 server->namelen = NFS3_MAXNAMLEN;
605 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
606 server->caps |= NFS_CAP_READDIRPLUS;
608 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
609 server->namelen = NFS2_MAXNAMLEN;
612 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
616 server->nfs_client = NULL;
618 dprintk("<-- nfs_init_server() = xerror %d\n", error);
623 * Load up the server record from information gained in an fsinfo record
625 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
627 unsigned long max_rpc_payload;
629 /* Work out a lot of parameters */
630 if (server->rsize == 0)
631 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
632 if (server->wsize == 0)
633 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
635 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
636 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
637 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
638 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
640 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
641 if (server->rsize > max_rpc_payload)
642 server->rsize = max_rpc_payload;
643 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
644 server->rsize = NFS_MAX_FILE_IO_SIZE;
645 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
646 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
648 if (server->wsize > max_rpc_payload)
649 server->wsize = max_rpc_payload;
650 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
651 server->wsize = NFS_MAX_FILE_IO_SIZE;
652 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
653 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
655 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
656 if (server->dtsize > PAGE_CACHE_SIZE)
657 server->dtsize = PAGE_CACHE_SIZE;
658 if (server->dtsize > server->rsize)
659 server->dtsize = server->rsize;
661 if (server->flags & NFS_MOUNT_NOAC) {
662 server->acregmin = server->acregmax = 0;
663 server->acdirmin = server->acdirmax = 0;
666 server->maxfilesize = fsinfo->maxfilesize;
668 /* We're airborne Set socket buffersize */
669 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
673 * Probe filesystem information, including the FSID on v2/v3
675 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
677 struct nfs_fsinfo fsinfo;
678 struct nfs_client *clp = server->nfs_client;
681 dprintk("--> nfs_probe_fsinfo()\n");
683 if (clp->rpc_ops->set_capabilities != NULL) {
684 error = clp->rpc_ops->set_capabilities(server, mntfh);
689 fsinfo.fattr = fattr;
690 nfs_fattr_init(fattr);
691 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
695 nfs_server_set_fsinfo(server, &fsinfo);
697 /* Get some general file system info */
698 if (server->namelen == 0) {
699 struct nfs_pathconf pathinfo;
701 pathinfo.fattr = fattr;
702 nfs_fattr_init(fattr);
704 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
705 server->namelen = pathinfo.max_namelen;
708 dprintk("<-- nfs_probe_fsinfo() = 0\n");
712 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
717 * Copy useful information when duplicating a server record
719 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
721 target->flags = source->flags;
722 target->acregmin = source->acregmin;
723 target->acregmax = source->acregmax;
724 target->acdirmin = source->acdirmin;
725 target->acdirmax = source->acdirmax;
726 target->caps = source->caps;
730 * Allocate and initialise a server record
732 static struct nfs_server *nfs_alloc_server(void)
734 struct nfs_server *server;
736 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
740 server->client = server->client_acl = ERR_PTR(-EINVAL);
742 /* Zero out the NFS state stuff */
743 INIT_LIST_HEAD(&server->client_link);
744 INIT_LIST_HEAD(&server->master_link);
746 server->io_stats = nfs_alloc_iostats();
747 if (!server->io_stats) {
756 * Free up a server record
758 void nfs_free_server(struct nfs_server *server)
760 dprintk("--> nfs_free_server()\n");
762 spin_lock(&nfs_client_lock);
763 list_del(&server->client_link);
764 list_del(&server->master_link);
765 spin_unlock(&nfs_client_lock);
767 if (server->destroy != NULL)
768 server->destroy(server);
769 if (!IS_ERR(server->client))
770 rpc_shutdown_client(server->client);
772 nfs_put_client(server->nfs_client);
774 nfs_free_iostats(server->io_stats);
776 nfs_release_automount_timer();
777 dprintk("<-- nfs_free_server()\n");
781 * Create a version 2 or 3 volume record
782 * - keyed on server and FSID
784 struct nfs_server *nfs_create_server(const struct nfs_mount_data *data,
785 struct nfs_fh *mntfh)
787 struct nfs_server *server;
788 struct nfs_fattr fattr;
791 server = nfs_alloc_server();
793 return ERR_PTR(-ENOMEM);
795 /* Get a client representation */
796 error = nfs_init_server(server, data);
800 BUG_ON(!server->nfs_client);
801 BUG_ON(!server->nfs_client->rpc_ops);
802 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
804 /* Probe the root fh to retrieve its FSID */
805 error = nfs_probe_fsinfo(server, mntfh, &fattr);
808 if (!(fattr.valid & NFS_ATTR_FATTR)) {
809 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
811 dprintk("nfs_create_server: getattr error = %d\n", -error);
815 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
817 dprintk("Server FSID: %llx:%llx\n",
818 (unsigned long long) server->fsid.major,
819 (unsigned long long) server->fsid.minor);
821 BUG_ON(!server->nfs_client);
822 BUG_ON(!server->nfs_client->rpc_ops);
823 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
825 spin_lock(&nfs_client_lock);
826 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
827 list_add_tail(&server->master_link, &nfs_volume_list);
828 spin_unlock(&nfs_client_lock);
830 server->mount_time = jiffies;
834 nfs_free_server(server);
835 return ERR_PTR(error);
840 * Initialise an NFS4 client record
842 static int nfs4_init_client(struct nfs_client *clp,
843 int proto, int timeo, int retrans,
845 rpc_authflavor_t authflavour)
849 if (clp->cl_cons_state == NFS_CS_READY) {
850 /* the client is initialised already */
851 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
855 /* Check NFS protocol revision and initialize RPC op vector */
856 clp->rpc_ops = &nfs_v4_clientops;
858 error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour,
859 RPC_CLNT_CREATE_DISCRTRY);
862 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
864 error = nfs_idmap_new(clp);
866 dprintk("%s: failed to create idmapper. Error = %d\n",
867 __FUNCTION__, error);
870 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
872 nfs_mark_client_ready(clp, NFS_CS_READY);
876 nfs_mark_client_ready(clp, error);
877 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
882 * Set up an NFS4 client
884 static int nfs4_set_client(struct nfs_server *server,
885 const char *hostname, const struct sockaddr_in *addr,
887 rpc_authflavor_t authflavour,
888 int proto, int timeo, int retrans)
890 struct nfs_client *clp;
893 dprintk("--> nfs4_set_client()\n");
895 /* Allocate or find a client reference we can use */
896 clp = nfs_get_client(hostname, addr, 4);
898 error = PTR_ERR(clp);
901 error = nfs4_init_client(clp, proto, timeo, retrans, ip_addr, authflavour);
905 server->nfs_client = clp;
906 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
912 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
917 * Create a version 4 volume record
919 static int nfs4_init_server(struct nfs_server *server,
920 const struct nfs4_mount_data *data, rpc_authflavor_t authflavour)
924 dprintk("--> nfs4_init_server()\n");
926 /* Initialise the client representation from the mount data */
927 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
928 server->caps |= NFS_CAP_ATOMIC_OPEN;
931 server->rsize = nfs_block_size(data->rsize, NULL);
933 server->wsize = nfs_block_size(data->wsize, NULL);
935 server->acregmin = data->acregmin * HZ;
936 server->acregmax = data->acregmax * HZ;
937 server->acdirmin = data->acdirmin * HZ;
938 server->acdirmax = data->acdirmax * HZ;
940 error = nfs_init_server_rpcclient(server, authflavour);
943 dprintk("<-- nfs4_init_server() = %d\n", error);
948 * Create a version 4 volume record
949 * - keyed on server and FSID
951 struct nfs_server *nfs4_create_server(const struct nfs4_mount_data *data,
952 const char *hostname,
953 const struct sockaddr_in *addr,
956 rpc_authflavor_t authflavour,
957 struct nfs_fh *mntfh)
959 struct nfs_fattr fattr;
960 struct nfs_server *server;
963 dprintk("--> nfs4_create_server()\n");
965 server = nfs_alloc_server();
967 return ERR_PTR(-ENOMEM);
969 /* Get a client record */
970 error = nfs4_set_client(server, hostname, addr, ip_addr, authflavour,
971 data->proto, data->timeo, data->retrans);
975 /* set up the general RPC client */
976 error = nfs4_init_server(server, data, authflavour);
980 BUG_ON(!server->nfs_client);
981 BUG_ON(!server->nfs_client->rpc_ops);
982 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
984 /* Probe the root fh to retrieve its FSID */
985 error = nfs4_path_walk(server, mntfh, mntpath);
989 dprintk("Server FSID: %llx:%llx\n",
990 (unsigned long long) server->fsid.major,
991 (unsigned long long) server->fsid.minor);
992 dprintk("Mount FH: %d\n", mntfh->size);
994 error = nfs_probe_fsinfo(server, mntfh, &fattr);
998 BUG_ON(!server->nfs_client);
999 BUG_ON(!server->nfs_client->rpc_ops);
1000 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1002 spin_lock(&nfs_client_lock);
1003 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1004 list_add_tail(&server->master_link, &nfs_volume_list);
1005 spin_unlock(&nfs_client_lock);
1007 server->mount_time = jiffies;
1008 dprintk("<-- nfs4_create_server() = %p\n", server);
1012 nfs_free_server(server);
1013 dprintk("<-- nfs4_create_server() = error %d\n", error);
1014 return ERR_PTR(error);
1018 * Create an NFS4 referral server record
1020 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1021 struct nfs_fh *mntfh)
1023 struct nfs_client *parent_client;
1024 struct nfs_server *server, *parent_server;
1025 struct nfs_fattr fattr;
1028 dprintk("--> nfs4_create_referral_server()\n");
1030 server = nfs_alloc_server();
1032 return ERR_PTR(-ENOMEM);
1034 parent_server = NFS_SB(data->sb);
1035 parent_client = parent_server->nfs_client;
1037 /* Get a client representation.
1038 * Note: NFSv4 always uses TCP, */
1039 error = nfs4_set_client(server, data->hostname, data->addr,
1040 parent_client->cl_ipaddr,
1042 parent_server->client->cl_xprt->prot,
1043 parent_client->retrans_timeo,
1044 parent_client->retrans_count);
1048 /* Initialise the client representation from the parent server */
1049 nfs_server_copy_userdata(server, parent_server);
1050 server->caps |= NFS_CAP_ATOMIC_OPEN;
1052 error = nfs_init_server_rpcclient(server, data->authflavor);
1056 BUG_ON(!server->nfs_client);
1057 BUG_ON(!server->nfs_client->rpc_ops);
1058 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1060 /* Probe the root fh to retrieve its FSID and filehandle */
1061 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1065 /* probe the filesystem info for this server filesystem */
1066 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1070 dprintk("Referral FSID: %llx:%llx\n",
1071 (unsigned long long) server->fsid.major,
1072 (unsigned long long) server->fsid.minor);
1074 spin_lock(&nfs_client_lock);
1075 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1076 list_add_tail(&server->master_link, &nfs_volume_list);
1077 spin_unlock(&nfs_client_lock);
1079 server->mount_time = jiffies;
1081 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1085 nfs_free_server(server);
1086 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1087 return ERR_PTR(error);
1090 #endif /* CONFIG_NFS_V4 */
1093 * Clone an NFS2, NFS3 or NFS4 server record
1095 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1097 struct nfs_fattr *fattr)
1099 struct nfs_server *server;
1100 struct nfs_fattr fattr_fsinfo;
1103 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1104 (unsigned long long) fattr->fsid.major,
1105 (unsigned long long) fattr->fsid.minor);
1107 server = nfs_alloc_server();
1109 return ERR_PTR(-ENOMEM);
1111 /* Copy data from the source */
1112 server->nfs_client = source->nfs_client;
1113 atomic_inc(&server->nfs_client->cl_count);
1114 nfs_server_copy_userdata(server, source);
1116 server->fsid = fattr->fsid;
1118 error = nfs_init_server_rpcclient(server, source->client->cl_auth->au_flavor);
1120 goto out_free_server;
1121 if (!IS_ERR(source->client_acl))
1122 nfs_init_server_aclclient(server);
1124 /* probe the filesystem info for this server filesystem */
1125 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1127 goto out_free_server;
1129 dprintk("Cloned FSID: %llx:%llx\n",
1130 (unsigned long long) server->fsid.major,
1131 (unsigned long long) 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 const 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 const 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\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 (unsigned long long) server->fsid.major,
1376 (unsigned long long) server->fsid.minor);
1378 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %-7s %-17s\n",
1380 NIPQUAD(clp->cl_addr.sin_addr),
1381 ntohs(clp->cl_addr.sin_port),
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 */