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/config.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
17 #include <linux/time.h>
18 #include <linux/kernel.h>
20 #include <linux/string.h>
21 #include <linux/stat.h>
22 #include <linux/errno.h>
23 #include <linux/unistd.h>
24 #include <linux/sunrpc/clnt.h>
25 #include <linux/sunrpc/stats.h>
26 #include <linux/sunrpc/metrics.h>
27 #include <linux/nfs_fs.h>
28 #include <linux/nfs_mount.h>
29 #include <linux/nfs4_mount.h>
30 #include <linux/lockd/bind.h>
31 #include <linux/smp_lock.h>
32 #include <linux/seq_file.h>
33 #include <linux/mount.h>
34 #include <linux/nfs_idmap.h>
35 #include <linux/vfs.h>
36 #include <linux/inet.h>
37 #include <linux/nfs_xdr.h>
39 #include <asm/system.h>
43 #include "delegation.h"
47 #define NFSDBG_FACILITY NFSDBG_CLIENT
49 static DEFINE_SPINLOCK(nfs_client_lock);
50 static LIST_HEAD(nfs_client_list);
51 static LIST_HEAD(nfs_volume_list);
52 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
57 static struct rpc_version *nfs_version[5] = {
67 struct rpc_program nfs_program = {
69 .number = NFS_PROGRAM,
70 .nrvers = ARRAY_SIZE(nfs_version),
71 .version = nfs_version,
72 .stats = &nfs_rpcstat,
73 .pipe_dir_name = "/nfs",
76 struct rpc_stat nfs_rpcstat = {
77 .program = &nfs_program
81 #ifdef CONFIG_NFS_V3_ACL
82 static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
83 static struct rpc_version * nfsacl_version[] = {
84 [3] = &nfsacl_version3,
87 struct rpc_program nfsacl_program = {
89 .number = NFS_ACL_PROGRAM,
90 .nrvers = ARRAY_SIZE(nfsacl_version),
91 .version = nfsacl_version,
92 .stats = &nfsacl_rpcstat,
94 #endif /* CONFIG_NFS_V3_ACL */
97 * Allocate a shared client record
99 * Since these are allocated/deallocated very rarely, we don't
100 * bother putting them in a slab cache...
102 static struct nfs_client *nfs_alloc_client(const char *hostname,
103 const struct sockaddr_in *addr,
106 struct nfs_client *clp;
109 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
114 dprintk("%s: couldn't start rpciod! Error = %d\n",
115 __FUNCTION__, error);
116 __set_bit(NFS_CS_RPCIOD, &clp->cl_res_state);
120 if (nfsversion == 4) {
121 if (nfs_callback_up() < 0)
123 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
126 atomic_set(&clp->cl_count, 1);
127 clp->cl_cons_state = NFS_CS_INITING;
129 clp->cl_nfsversion = nfsversion;
130 memcpy(&clp->cl_addr, addr, sizeof(clp->cl_addr));
133 clp->cl_hostname = kstrdup(hostname, GFP_KERNEL);
134 if (!clp->cl_hostname)
138 INIT_LIST_HEAD(&clp->cl_superblocks);
139 clp->cl_rpcclient = ERR_PTR(-EINVAL);
142 init_rwsem(&clp->cl_sem);
143 INIT_LIST_HEAD(&clp->cl_delegations);
144 INIT_LIST_HEAD(&clp->cl_state_owners);
145 INIT_LIST_HEAD(&clp->cl_unused);
146 spin_lock_init(&clp->cl_lock);
147 INIT_WORK(&clp->cl_renewd, nfs4_renew_state, clp);
148 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
149 clp->cl_boot_time = CURRENT_TIME;
150 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
157 __clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
160 __clear_bit(NFS_CS_RPCIOD, &clp->cl_res_state);
168 * Destroy a shared client record
170 static void nfs_free_client(struct nfs_client *clp)
172 dprintk("--> nfs_free_client(%d)\n", clp->cl_nfsversion);
175 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state)) {
176 while (!list_empty(&clp->cl_unused)) {
177 struct nfs4_state_owner *sp;
179 sp = list_entry(clp->cl_unused.next,
180 struct nfs4_state_owner,
182 list_del(&sp->so_list);
185 BUG_ON(!list_empty(&clp->cl_state_owners));
186 nfs_idmap_delete(clp);
190 /* -EIO all pending I/O */
191 if (!IS_ERR(clp->cl_rpcclient))
192 rpc_shutdown_client(clp->cl_rpcclient);
194 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
197 if (__test_and_clear_bit(NFS_CS_RPCIOD, &clp->cl_res_state))
200 kfree(clp->cl_hostname);
203 dprintk("<-- nfs_free_client()\n");
207 * Release a reference to a shared client record
209 void nfs_put_client(struct nfs_client *clp)
211 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
213 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
214 list_del(&clp->cl_share_link);
215 spin_unlock(&nfs_client_lock);
217 BUG_ON(!list_empty(&clp->cl_superblocks));
219 nfs_free_client(clp);
224 * Find a client by address
225 * - caller must hold nfs_client_lock
227 static struct nfs_client *__nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
229 struct nfs_client *clp;
231 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
232 /* Different NFS versions cannot share the same nfs_client */
233 if (clp->cl_nfsversion != nfsversion)
236 if (memcmp(&clp->cl_addr.sin_addr, &addr->sin_addr,
237 sizeof(clp->cl_addr.sin_addr)) != 0)
240 if (clp->cl_addr.sin_port == addr->sin_port)
247 atomic_inc(&clp->cl_count);
252 * Find a client by IP address and protocol version
253 * - returns NULL if no such client
255 struct nfs_client *nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
257 struct nfs_client *clp;
259 spin_lock(&nfs_client_lock);
260 clp = __nfs_find_client(addr, nfsversion);
261 spin_unlock(&nfs_client_lock);
263 BUG_ON(clp->cl_cons_state == 0);
269 * Look up a client by IP address and protocol version
270 * - creates a new record if one doesn't yet exist
272 static struct nfs_client *nfs_get_client(const char *hostname,
273 const struct sockaddr_in *addr,
276 struct nfs_client *clp, *new = NULL;
279 dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT":%d,%d)\n",
280 hostname ?: "", NIPQUAD(addr->sin_addr),
281 addr->sin_port, nfsversion);
283 /* see if the client already exists */
285 spin_lock(&nfs_client_lock);
287 clp = __nfs_find_client(addr, nfsversion);
293 spin_unlock(&nfs_client_lock);
295 new = nfs_alloc_client(hostname, addr, nfsversion);
298 return ERR_PTR(-ENOMEM);
300 /* install a new client and return with it unready */
303 list_add(&clp->cl_share_link, &nfs_client_list);
304 spin_unlock(&nfs_client_lock);
305 dprintk("--> nfs_get_client() = %p [new]\n", clp);
308 /* found an existing client
309 * - make sure it's ready before returning
312 spin_unlock(&nfs_client_lock);
315 nfs_free_client(new);
317 if (clp->cl_cons_state == NFS_CS_INITING) {
318 DECLARE_WAITQUEUE(myself, current);
320 add_wait_queue(&nfs_client_active_wq, &myself);
323 set_current_state(TASK_INTERRUPTIBLE);
324 if (signal_pending(current) ||
325 clp->cl_cons_state > NFS_CS_READY)
330 remove_wait_queue(&nfs_client_active_wq, &myself);
332 if (signal_pending(current)) {
334 return ERR_PTR(-ERESTARTSYS);
338 if (clp->cl_cons_state < NFS_CS_READY) {
339 error = clp->cl_cons_state;
341 return ERR_PTR(error);
344 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
346 dprintk("--> nfs_get_client() = %p [share]\n", clp);
351 * Mark a server as ready or failed
353 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
355 clp->cl_cons_state = state;
356 wake_up_all(&nfs_client_active_wq);
360 * Initialise the timeout values for a connection
362 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
363 unsigned int timeo, unsigned int retrans)
365 to->to_initval = timeo * HZ / 10;
366 to->to_retries = retrans;
373 to->to_initval = 60 * HZ;
374 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
375 to->to_initval = NFS_MAX_TCP_TIMEOUT;
376 to->to_increment = to->to_initval;
377 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
378 to->to_exponential = 0;
383 to->to_initval = 11 * HZ / 10;
384 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
385 to->to_initval = NFS_MAX_UDP_TIMEOUT;
386 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
387 to->to_exponential = 1;
393 * Create an RPC client handle
395 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
397 unsigned int retrans,
398 rpc_authflavor_t flavor)
400 struct rpc_timeout timeparms;
401 struct rpc_xprt *xprt = NULL;
402 struct rpc_clnt *clnt = NULL;
404 if (!IS_ERR(clp->cl_rpcclient))
407 nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
408 clp->retrans_timeo = timeparms.to_initval;
409 clp->retrans_count = timeparms.to_retries;
411 /* create transport and client */
412 xprt = xprt_create_proto(proto, &clp->cl_addr, &timeparms);
414 dprintk("%s: cannot create RPC transport. Error = %ld\n",
415 __FUNCTION__, PTR_ERR(xprt));
416 return PTR_ERR(xprt);
419 /* Bind to a reserved port! */
421 /* Create the client RPC handle */
422 clnt = rpc_create_client(xprt, clp->cl_hostname, &nfs_program,
423 clp->rpc_ops->version, RPC_AUTH_UNIX);
425 dprintk("%s: cannot create RPC client. Error = %ld\n",
426 __FUNCTION__, PTR_ERR(clnt));
427 return PTR_ERR(clnt);
431 clnt->cl_softrtry = 1;
432 clp->cl_rpcclient = clnt;
437 * Version 2 or 3 client destruction
439 static void nfs_destroy_server(struct nfs_server *server)
441 if (!IS_ERR(server->client_acl))
442 rpc_shutdown_client(server->client_acl);
444 if (!(server->flags & NFS_MOUNT_NONLM))
445 lockd_down(); /* release rpc.lockd */
449 * Version 2 or 3 lockd setup
451 static int nfs_start_lockd(struct nfs_server *server)
455 if (server->nfs_client->cl_nfsversion > 3)
457 if (server->flags & NFS_MOUNT_NONLM)
461 server->flags |= NFS_MOUNT_NONLM;
463 server->destroy = nfs_destroy_server;
469 * Initialise an NFSv3 ACL client connection
471 #ifdef CONFIG_NFS_V3_ACL
472 static void nfs_init_server_aclclient(struct nfs_server *server)
474 if (server->nfs_client->cl_nfsversion != 3)
476 if (server->flags & NFS_MOUNT_NOACL)
479 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
480 if (IS_ERR(server->client_acl))
483 /* No errors! Assume that Sun nfsacls are supported */
484 server->caps |= NFS_CAP_ACLS;
488 server->caps &= ~NFS_CAP_ACLS;
491 static inline void nfs_init_server_aclclient(struct nfs_server *server)
493 server->flags &= ~NFS_MOUNT_NOACL;
494 server->caps &= ~NFS_CAP_ACLS;
499 * Create a general RPC client
501 static int nfs_init_server_rpcclient(struct nfs_server *server, rpc_authflavor_t pseudoflavour)
503 struct nfs_client *clp = server->nfs_client;
505 server->client = rpc_clone_client(clp->cl_rpcclient);
506 if (IS_ERR(server->client)) {
507 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
508 return PTR_ERR(server->client);
511 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
512 struct rpc_auth *auth;
514 auth = rpcauth_create(pseudoflavour, server->client);
516 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
517 return PTR_ERR(auth);
520 server->client->cl_softrtry = 0;
521 if (server->flags & NFS_MOUNT_SOFT)
522 server->client->cl_softrtry = 1;
524 server->client->cl_intr = 0;
525 if (server->flags & NFS4_MOUNT_INTR)
526 server->client->cl_intr = 1;
532 * Initialise an NFS2 or NFS3 client
534 static int nfs_init_client(struct nfs_client *clp, const struct nfs_mount_data *data)
536 int proto = (data->flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
539 if (clp->cl_cons_state == NFS_CS_READY) {
540 /* the client is already initialised */
541 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
545 /* Check NFS protocol revision and initialize RPC op vector */
546 clp->rpc_ops = &nfs_v2_clientops;
548 if (clp->cl_nfsversion == 3)
549 clp->rpc_ops = &nfs_v3_clientops;
552 * Create a client RPC handle for doing FSSTAT with UNIX auth only
553 * - RFC 2623, sec 2.3.2
555 error = nfs_create_rpc_client(clp, proto, data->timeo, data->retrans,
559 nfs_mark_client_ready(clp, NFS_CS_READY);
563 nfs_mark_client_ready(clp, error);
564 dprintk("<-- nfs_init_client() = xerror %d\n", error);
569 * Create a version 2 or 3 client
571 static int nfs_init_server(struct nfs_server *server, const struct nfs_mount_data *data)
573 struct nfs_client *clp;
574 int error, nfsvers = 2;
576 dprintk("--> nfs_init_server()\n");
579 if (data->flags & NFS_MOUNT_VER3)
583 /* Allocate or find a client reference we can use */
584 clp = nfs_get_client(data->hostname, &data->addr, nfsvers);
586 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
590 error = nfs_init_client(clp, data);
594 server->nfs_client = clp;
596 /* Initialise the client representation from the mount data */
597 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
600 server->rsize = nfs_block_size(data->rsize, NULL);
602 server->wsize = nfs_block_size(data->wsize, NULL);
604 server->acregmin = data->acregmin * HZ;
605 server->acregmax = data->acregmax * HZ;
606 server->acdirmin = data->acdirmin * HZ;
607 server->acdirmax = data->acdirmax * HZ;
609 /* Start lockd here, before we might error out */
610 error = nfs_start_lockd(server);
614 error = nfs_init_server_rpcclient(server, data->pseudoflavor);
618 server->namelen = data->namlen;
619 /* Create a client RPC handle for the NFSv3 ACL management interface */
620 nfs_init_server_aclclient(server);
621 if (clp->cl_nfsversion == 3) {
622 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
623 server->namelen = NFS3_MAXNAMLEN;
624 server->caps |= NFS_CAP_READDIRPLUS;
626 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
627 server->namelen = NFS2_MAXNAMLEN;
630 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
634 server->nfs_client = NULL;
636 dprintk("<-- nfs_init_server() = xerror %d\n", error);
641 * Load up the server record from information gained in an fsinfo record
643 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
645 unsigned long max_rpc_payload;
647 /* Work out a lot of parameters */
648 if (server->rsize == 0)
649 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
650 if (server->wsize == 0)
651 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
653 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
654 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
655 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
656 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
658 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
659 if (server->rsize > max_rpc_payload)
660 server->rsize = max_rpc_payload;
661 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
662 server->rsize = NFS_MAX_FILE_IO_SIZE;
663 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
664 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
666 if (server->wsize > max_rpc_payload)
667 server->wsize = max_rpc_payload;
668 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
669 server->wsize = NFS_MAX_FILE_IO_SIZE;
670 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
671 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
673 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
674 if (server->dtsize > PAGE_CACHE_SIZE)
675 server->dtsize = PAGE_CACHE_SIZE;
676 if (server->dtsize > server->rsize)
677 server->dtsize = server->rsize;
679 if (server->flags & NFS_MOUNT_NOAC) {
680 server->acregmin = server->acregmax = 0;
681 server->acdirmin = server->acdirmax = 0;
684 server->maxfilesize = fsinfo->maxfilesize;
686 /* We're airborne Set socket buffersize */
687 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
691 * Probe filesystem information, including the FSID on v2/v3
693 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
695 struct nfs_fsinfo fsinfo;
696 struct nfs_client *clp = server->nfs_client;
699 dprintk("--> nfs_probe_fsinfo()\n");
701 if (clp->rpc_ops->set_capabilities != NULL) {
702 error = clp->rpc_ops->set_capabilities(server, mntfh);
707 fsinfo.fattr = fattr;
708 nfs_fattr_init(fattr);
709 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
713 nfs_server_set_fsinfo(server, &fsinfo);
715 /* Get some general file system info */
716 if (server->namelen == 0) {
717 struct nfs_pathconf pathinfo;
719 pathinfo.fattr = fattr;
720 nfs_fattr_init(fattr);
722 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
723 server->namelen = pathinfo.max_namelen;
726 dprintk("<-- nfs_probe_fsinfo() = 0\n");
730 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
735 * Copy useful information when duplicating a server record
737 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
739 target->flags = source->flags;
740 target->acregmin = source->acregmin;
741 target->acregmax = source->acregmax;
742 target->acdirmin = source->acdirmin;
743 target->acdirmax = source->acdirmax;
744 target->caps = source->caps;
748 * Allocate and initialise a server record
750 static struct nfs_server *nfs_alloc_server(void)
752 struct nfs_server *server;
754 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
758 server->client = server->client_acl = ERR_PTR(-EINVAL);
760 /* Zero out the NFS state stuff */
761 INIT_LIST_HEAD(&server->client_link);
762 INIT_LIST_HEAD(&server->master_link);
764 server->io_stats = nfs_alloc_iostats();
765 if (!server->io_stats) {
774 * Free up a server record
776 void nfs_free_server(struct nfs_server *server)
778 dprintk("--> nfs_free_server()\n");
780 spin_lock(&nfs_client_lock);
781 list_del(&server->client_link);
782 list_del(&server->master_link);
783 spin_unlock(&nfs_client_lock);
785 if (server->destroy != NULL)
786 server->destroy(server);
787 if (!IS_ERR(server->client))
788 rpc_shutdown_client(server->client);
790 nfs_put_client(server->nfs_client);
792 nfs_free_iostats(server->io_stats);
794 nfs_release_automount_timer();
795 dprintk("<-- nfs_free_server()\n");
799 * Create a version 2 or 3 volume record
800 * - keyed on server and FSID
802 struct nfs_server *nfs_create_server(const struct nfs_mount_data *data,
803 struct nfs_fh *mntfh)
805 struct nfs_server *server;
806 struct nfs_fattr fattr;
809 server = nfs_alloc_server();
811 return ERR_PTR(-ENOMEM);
813 /* Get a client representation */
814 error = nfs_init_server(server, data);
818 BUG_ON(!server->nfs_client);
819 BUG_ON(!server->nfs_client->rpc_ops);
820 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
822 /* Probe the root fh to retrieve its FSID */
823 error = nfs_probe_fsinfo(server, mntfh, &fattr);
826 if (!(fattr.valid & NFS_ATTR_FATTR)) {
827 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
829 dprintk("nfs_create_server: getattr error = %d\n", -error);
833 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
835 dprintk("Server FSID: %llx:%llx\n", server->fsid.major, server->fsid.minor);
837 BUG_ON(!server->nfs_client);
838 BUG_ON(!server->nfs_client->rpc_ops);
839 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
841 spin_lock(&nfs_client_lock);
842 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
843 list_add_tail(&server->master_link, &nfs_volume_list);
844 spin_unlock(&nfs_client_lock);
846 server->mount_time = jiffies;
850 nfs_free_server(server);
851 return ERR_PTR(error);
856 * Initialise an NFS4 client record
858 static int nfs4_init_client(struct nfs_client *clp,
859 int proto, int timeo, int retrans,
860 rpc_authflavor_t authflavour)
864 if (clp->cl_cons_state == NFS_CS_READY) {
865 /* the client is initialised already */
866 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
870 /* Check NFS protocol revision and initialize RPC op vector */
871 clp->rpc_ops = &nfs_v4_clientops;
873 error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour);
877 error = nfs_idmap_new(clp);
879 dprintk("%s: failed to create idmapper. Error = %d\n",
880 __FUNCTION__, error);
881 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
885 nfs_mark_client_ready(clp, NFS_CS_READY);
889 nfs_mark_client_ready(clp, error);
890 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
895 * Set up an NFS4 client
897 static int nfs4_set_client(struct nfs_server *server,
898 const char *hostname, const struct sockaddr_in *addr,
899 rpc_authflavor_t authflavour,
900 int proto, int timeo, int retrans)
902 struct nfs_client *clp;
905 dprintk("--> nfs4_set_client()\n");
907 /* Allocate or find a client reference we can use */
908 clp = nfs_get_client(hostname, addr, 4);
910 error = PTR_ERR(clp);
913 error = nfs4_init_client(clp, proto, timeo, retrans, authflavour);
917 server->nfs_client = clp;
918 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
924 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
929 * Create a version 4 volume record
931 static int nfs4_init_server(struct nfs_server *server,
932 const struct nfs4_mount_data *data, rpc_authflavor_t authflavour)
936 dprintk("--> nfs4_init_server()\n");
938 /* Initialise the client representation from the mount data */
939 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
940 server->caps |= NFS_CAP_ATOMIC_OPEN;
943 server->rsize = nfs_block_size(data->rsize, NULL);
945 server->wsize = nfs_block_size(data->wsize, NULL);
947 server->acregmin = data->acregmin * HZ;
948 server->acregmax = data->acregmax * HZ;
949 server->acdirmin = data->acdirmin * HZ;
950 server->acdirmax = data->acdirmax * HZ;
952 error = nfs_init_server_rpcclient(server, authflavour);
955 dprintk("<-- nfs4_init_server() = %d\n", error);
960 * Create a version 4 volume record
961 * - keyed on server and FSID
963 struct nfs_server *nfs4_create_server(const struct nfs4_mount_data *data,
964 const char *hostname,
965 const struct sockaddr_in *addr,
968 rpc_authflavor_t authflavour,
969 struct nfs_fh *mntfh)
971 struct nfs_fattr fattr;
972 struct nfs_server *server;
975 dprintk("--> nfs4_create_server()\n");
977 server = nfs_alloc_server();
979 return ERR_PTR(-ENOMEM);
981 /* Get a client record */
982 error = nfs4_set_client(server, hostname, addr, authflavour,
983 data->proto, data->timeo, data->retrans);
987 /* set up the general RPC client */
988 error = nfs4_init_server(server, data, authflavour);
992 BUG_ON(!server->nfs_client);
993 BUG_ON(!server->nfs_client->rpc_ops);
994 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
996 /* Probe the root fh to retrieve its FSID */
997 error = nfs4_path_walk(server, mntfh, mntpath);
1001 dprintk("Server FSID: %llx:%llx\n", server->fsid.major, server->fsid.minor);
1002 dprintk("Mount FH: %d\n", mntfh->size);
1004 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1008 BUG_ON(!server->nfs_client);
1009 BUG_ON(!server->nfs_client->rpc_ops);
1010 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1012 spin_lock(&nfs_client_lock);
1013 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1014 list_add_tail(&server->master_link, &nfs_volume_list);
1015 spin_unlock(&nfs_client_lock);
1017 server->mount_time = jiffies;
1018 dprintk("<-- nfs4_create_server() = %p\n", server);
1022 nfs_free_server(server);
1023 dprintk("<-- nfs4_create_server() = error %d\n", error);
1024 return ERR_PTR(error);
1028 * Create an NFS4 referral server record
1030 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1033 struct nfs_client *parent_client;
1034 struct nfs_server *server, *parent_server;
1035 struct nfs_fattr fattr;
1038 dprintk("--> nfs4_create_referral_server()\n");
1040 server = nfs_alloc_server();
1042 return ERR_PTR(-ENOMEM);
1044 parent_server = NFS_SB(data->sb);
1045 parent_client = parent_server->nfs_client;
1047 /* Get a client representation.
1048 * Note: NFSv4 always uses TCP, */
1049 error = nfs4_set_client(server, data->hostname, data->addr,
1051 parent_server->client->cl_xprt->prot,
1052 parent_client->retrans_timeo,
1053 parent_client->retrans_count);
1055 /* Initialise the client representation from the parent server */
1056 nfs_server_copy_userdata(server, parent_server);
1057 server->caps |= NFS_CAP_ATOMIC_OPEN;
1059 error = nfs_init_server_rpcclient(server, data->authflavor);
1063 BUG_ON(!server->nfs_client);
1064 BUG_ON(!server->nfs_client->rpc_ops);
1065 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1067 /* probe the filesystem info for this server filesystem */
1068 error = nfs_probe_fsinfo(server, fh, &fattr);
1072 dprintk("Referral FSID: %llx:%llx\n",
1073 server->fsid.major, server->fsid.minor);
1075 spin_lock(&nfs_client_lock);
1076 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1077 list_add_tail(&server->master_link, &nfs_volume_list);
1078 spin_unlock(&nfs_client_lock);
1080 server->mount_time = jiffies;
1082 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1086 nfs_free_server(server);
1087 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1088 return ERR_PTR(error);
1091 #endif /* CONFIG_NFS_V4 */
1094 * Clone an NFS2, NFS3 or NFS4 server record
1096 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1098 struct nfs_fattr *fattr)
1100 struct nfs_server *server;
1101 struct nfs_fattr fattr_fsinfo;
1104 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1105 fattr->fsid.major, 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 server->fsid.major, server->fsid.minor);
1132 error = nfs_start_lockd(server);
1134 goto out_free_server;
1136 spin_lock(&nfs_client_lock);
1137 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1138 list_add_tail(&server->master_link, &nfs_volume_list);
1139 spin_unlock(&nfs_client_lock);
1141 server->mount_time = jiffies;
1143 dprintk("<-- nfs_clone_server() = %p\n", server);
1147 nfs_free_server(server);
1148 dprintk("<-- nfs_clone_server() = error %d\n", error);
1149 return ERR_PTR(error);
1152 #ifdef CONFIG_PROC_FS
1153 static struct proc_dir_entry *proc_fs_nfs;
1155 static int nfs_server_list_open(struct inode *inode, struct file *file);
1156 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1157 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1158 static void nfs_server_list_stop(struct seq_file *p, void *v);
1159 static int nfs_server_list_show(struct seq_file *m, void *v);
1161 static struct seq_operations nfs_server_list_ops = {
1162 .start = nfs_server_list_start,
1163 .next = nfs_server_list_next,
1164 .stop = nfs_server_list_stop,
1165 .show = nfs_server_list_show,
1168 static struct file_operations nfs_server_list_fops = {
1169 .open = nfs_server_list_open,
1171 .llseek = seq_lseek,
1172 .release = seq_release,
1175 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1176 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1177 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1178 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1179 static int nfs_volume_list_show(struct seq_file *m, void *v);
1181 static struct seq_operations nfs_volume_list_ops = {
1182 .start = nfs_volume_list_start,
1183 .next = nfs_volume_list_next,
1184 .stop = nfs_volume_list_stop,
1185 .show = nfs_volume_list_show,
1188 static struct file_operations nfs_volume_list_fops = {
1189 .open = nfs_volume_list_open,
1191 .llseek = seq_lseek,
1192 .release = seq_release,
1196 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1199 static int nfs_server_list_open(struct inode *inode, struct file *file)
1204 ret = seq_open(file, &nfs_server_list_ops);
1208 m = file->private_data;
1209 m->private = PDE(inode)->data;
1215 * set up the iterator to start reading from the server list and return the first item
1217 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1219 struct list_head *_p;
1222 /* lock the list against modification */
1223 spin_lock(&nfs_client_lock);
1225 /* allow for the header line */
1227 return SEQ_START_TOKEN;
1230 /* find the n'th element in the list */
1231 list_for_each(_p, &nfs_client_list)
1235 return _p != &nfs_client_list ? _p : NULL;
1239 * move to next server
1241 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1243 struct list_head *_p;
1248 _p = (v == SEQ_START_TOKEN) ? nfs_client_list.next : _p->next;
1250 return _p != &nfs_client_list ? _p : NULL;
1254 * clean up after reading from the transports list
1256 static void nfs_server_list_stop(struct seq_file *p, void *v)
1258 spin_unlock(&nfs_client_lock);
1262 * display a header line followed by a load of call lines
1264 static int nfs_server_list_show(struct seq_file *m, void *v)
1266 struct nfs_client *clp;
1268 /* display header on line 1 */
1269 if (v == SEQ_START_TOKEN) {
1270 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1274 /* display one transport per line on subsequent lines */
1275 clp = list_entry(v, struct nfs_client, cl_share_link);
1277 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %3d %s\n",
1279 NIPQUAD(clp->cl_addr.sin_addr),
1280 ntohs(clp->cl_addr.sin_port),
1281 atomic_read(&clp->cl_count),
1288 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1290 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1295 ret = seq_open(file, &nfs_volume_list_ops);
1299 m = file->private_data;
1300 m->private = PDE(inode)->data;
1306 * set up the iterator to start reading from the volume list and return the first item
1308 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1310 struct list_head *_p;
1313 /* lock the list against modification */
1314 spin_lock(&nfs_client_lock);
1316 /* allow for the header line */
1318 return SEQ_START_TOKEN;
1321 /* find the n'th element in the list */
1322 list_for_each(_p, &nfs_volume_list)
1326 return _p != &nfs_volume_list ? _p : NULL;
1330 * move to next volume
1332 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1334 struct list_head *_p;
1339 _p = (v == SEQ_START_TOKEN) ? nfs_volume_list.next : _p->next;
1341 return _p != &nfs_volume_list ? _p : NULL;
1345 * clean up after reading from the transports list
1347 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1349 spin_unlock(&nfs_client_lock);
1353 * display a header line followed by a load of call lines
1355 static int nfs_volume_list_show(struct seq_file *m, void *v)
1357 struct nfs_server *server;
1358 struct nfs_client *clp;
1359 char dev[8], fsid[17];
1361 /* display header on line 1 */
1362 if (v == SEQ_START_TOKEN) {
1363 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1366 /* display one transport per line on subsequent lines */
1367 server = list_entry(v, struct nfs_server, master_link);
1368 clp = server->nfs_client;
1370 snprintf(dev, 8, "%u:%u",
1371 MAJOR(server->s_dev), MINOR(server->s_dev));
1373 snprintf(fsid, 17, "%llx:%llx",
1374 server->fsid.major, server->fsid.minor);
1376 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %-7s %-17s\n",
1378 NIPQUAD(clp->cl_addr.sin_addr),
1379 ntohs(clp->cl_addr.sin_port),
1387 * initialise the /proc/fs/nfsfs/ directory
1389 int __init nfs_fs_proc_init(void)
1391 struct proc_dir_entry *p;
1393 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1397 proc_fs_nfs->owner = THIS_MODULE;
1399 /* a file of servers with which we're dealing */
1400 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1404 p->proc_fops = &nfs_server_list_fops;
1405 p->owner = THIS_MODULE;
1407 /* a file of volumes that we have mounted */
1408 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1412 p->proc_fops = &nfs_volume_list_fops;
1413 p->owner = THIS_MODULE;
1417 remove_proc_entry("servers", proc_fs_nfs);
1419 remove_proc_entry("nfsfs", proc_root_fs);
1425 * clean up the /proc/fs/nfsfs/ directory
1427 void nfs_fs_proc_exit(void)
1429 remove_proc_entry("volumes", proc_fs_nfs);
1430 remove_proc_entry("servers", proc_fs_nfs);
1431 remove_proc_entry("nfsfs", proc_root_fs);
1434 #endif /* CONFIG_PROC_FS */