1 /* client.c: NFS client sharing and management code
3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/sched.h>
16 #include <linux/time.h>
17 #include <linux/kernel.h>
19 #include <linux/string.h>
20 #include <linux/stat.h>
21 #include <linux/errno.h>
22 #include <linux/unistd.h>
23 #include <linux/sunrpc/clnt.h>
24 #include <linux/sunrpc/stats.h>
25 #include <linux/sunrpc/metrics.h>
26 #include <linux/sunrpc/xprtsock.h>
27 #include <linux/sunrpc/xprtrdma.h>
28 #include <linux/nfs_fs.h>
29 #include <linux/nfs_mount.h>
30 #include <linux/nfs4_mount.h>
31 #include <linux/lockd/bind.h>
32 #include <linux/seq_file.h>
33 #include <linux/mount.h>
34 #include <linux/nfs_idmap.h>
35 #include <linux/vfs.h>
36 #include <linux/inet.h>
37 #include <linux/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 */
96 struct nfs_client_initdata {
98 const struct sockaddr_in *addr;
103 * Allocate a shared client record
105 * Since these are allocated/deallocated very rarely, we don't
106 * bother putting them in a slab cache...
108 static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
110 struct nfs_client *clp;
112 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
115 if (cl_init->version == 4) {
116 if (nfs_callback_up() < 0)
118 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
121 atomic_set(&clp->cl_count, 1);
122 clp->cl_cons_state = NFS_CS_INITING;
124 clp->cl_nfsversion = cl_init->version;
125 memcpy(&clp->cl_addr, cl_init->addr, sizeof(clp->cl_addr));
127 if (cl_init->hostname) {
128 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
129 if (!clp->cl_hostname)
133 INIT_LIST_HEAD(&clp->cl_superblocks);
134 clp->cl_rpcclient = ERR_PTR(-EINVAL);
137 init_rwsem(&clp->cl_sem);
138 INIT_LIST_HEAD(&clp->cl_delegations);
139 spin_lock_init(&clp->cl_lock);
140 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
141 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
142 clp->cl_boot_time = CURRENT_TIME;
143 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
149 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
157 static void nfs4_shutdown_client(struct nfs_client *clp)
160 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
161 nfs4_kill_renewd(clp);
162 BUG_ON(!RB_EMPTY_ROOT(&clp->cl_state_owners));
163 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
164 nfs_idmap_delete(clp);
169 * Destroy a shared client record
171 static void nfs_free_client(struct nfs_client *clp)
173 dprintk("--> nfs_free_client(%d)\n", clp->cl_nfsversion);
175 nfs4_shutdown_client(clp);
177 /* -EIO all pending I/O */
178 if (!IS_ERR(clp->cl_rpcclient))
179 rpc_shutdown_client(clp->cl_rpcclient);
181 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
184 kfree(clp->cl_hostname);
187 dprintk("<-- nfs_free_client()\n");
191 * Release a reference to a shared client record
193 void nfs_put_client(struct nfs_client *clp)
198 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
200 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
201 list_del(&clp->cl_share_link);
202 spin_unlock(&nfs_client_lock);
204 BUG_ON(!list_empty(&clp->cl_superblocks));
206 nfs_free_client(clp);
211 * Find a client by address
212 * - caller must hold nfs_client_lock
214 static struct nfs_client *__nfs_find_client(const struct sockaddr_in *addr, int nfsversion, int match_port)
216 struct nfs_client *clp;
218 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
219 /* Don't match clients that failed to initialise properly */
220 if (clp->cl_cons_state < 0)
223 /* Different NFS versions cannot share the same nfs_client */
224 if (clp->cl_nfsversion != nfsversion)
227 if (clp->cl_addr.sin_addr.s_addr != addr->sin_addr.s_addr)
230 if (!match_port || clp->cl_addr.sin_port == addr->sin_port)
237 atomic_inc(&clp->cl_count);
242 * Find a client by IP address and protocol version
243 * - returns NULL if no such client
245 struct nfs_client *nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
247 struct nfs_client *clp;
249 spin_lock(&nfs_client_lock);
250 clp = __nfs_find_client(addr, nfsversion, 0);
251 spin_unlock(&nfs_client_lock);
252 if (clp != NULL && clp->cl_cons_state != NFS_CS_READY) {
260 * Look up a client by IP address and protocol version
261 * - creates a new record if one doesn't yet exist
263 static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
265 struct nfs_client *clp, *new = NULL;
268 dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT":%d,%d)\n",
269 cl_init->hostname ?: "", NIPQUAD(cl_init->addr->sin_addr),
270 cl_init->addr->sin_port, cl_init->version);
272 /* see if the client already exists */
274 spin_lock(&nfs_client_lock);
276 clp = __nfs_find_client(cl_init->addr, cl_init->version, 1);
282 spin_unlock(&nfs_client_lock);
284 new = nfs_alloc_client(cl_init);
287 return ERR_PTR(-ENOMEM);
289 /* install a new client and return with it unready */
292 list_add(&clp->cl_share_link, &nfs_client_list);
293 spin_unlock(&nfs_client_lock);
294 dprintk("--> nfs_get_client() = %p [new]\n", clp);
297 /* found an existing client
298 * - make sure it's ready before returning
301 spin_unlock(&nfs_client_lock);
304 nfs_free_client(new);
306 error = wait_event_interruptible(nfs_client_active_wq,
307 clp->cl_cons_state != NFS_CS_INITING);
310 return ERR_PTR(-ERESTARTSYS);
313 if (clp->cl_cons_state < NFS_CS_READY) {
314 error = clp->cl_cons_state;
316 return ERR_PTR(error);
319 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
321 dprintk("--> nfs_get_client() = %p [share]\n", clp);
326 * Mark a server as ready or failed
328 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
330 clp->cl_cons_state = state;
331 wake_up_all(&nfs_client_active_wq);
335 * Initialise the timeout values for a connection
337 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
338 unsigned int timeo, unsigned int retrans)
340 to->to_initval = timeo * HZ / 10;
341 to->to_retries = retrans;
346 case XPRT_TRANSPORT_TCP:
347 case XPRT_TRANSPORT_RDMA:
349 to->to_initval = 60 * HZ;
350 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
351 to->to_initval = NFS_MAX_TCP_TIMEOUT;
352 to->to_increment = to->to_initval;
353 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
354 to->to_exponential = 0;
356 case XPRT_TRANSPORT_UDP:
359 to->to_initval = 11 * HZ / 10;
360 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
361 to->to_initval = NFS_MAX_UDP_TIMEOUT;
362 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
363 to->to_exponential = 1;
369 * Create an RPC client handle
371 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
373 unsigned int retrans,
374 rpc_authflavor_t flavor,
377 struct rpc_timeout timeparms;
378 struct rpc_clnt *clnt = NULL;
379 struct rpc_create_args args = {
381 .address = (struct sockaddr *)&clp->cl_addr,
382 .addrsize = sizeof(clp->cl_addr),
383 .timeout = &timeparms,
384 .servername = clp->cl_hostname,
385 .program = &nfs_program,
386 .version = clp->rpc_ops->version,
387 .authflavor = flavor,
391 if (!IS_ERR(clp->cl_rpcclient))
394 nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
395 clp->retrans_timeo = timeparms.to_initval;
396 clp->retrans_count = timeparms.to_retries;
398 clnt = rpc_create(&args);
400 dprintk("%s: cannot create RPC client. Error = %ld\n",
401 __FUNCTION__, PTR_ERR(clnt));
402 return PTR_ERR(clnt);
405 clp->cl_rpcclient = clnt;
410 * Version 2 or 3 client destruction
412 static void nfs_destroy_server(struct nfs_server *server)
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,
506 const struct nfs_parsed_mount_data *data)
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, data->nfs_server.protocol,
527 data->timeo, data->retrans, RPC_AUTH_UNIX, 0);
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,
543 const struct nfs_parsed_mount_data *data)
545 struct nfs_client_initdata cl_init = {
546 .hostname = data->nfs_server.hostname,
547 .addr = &data->nfs_server.address,
550 struct nfs_client *clp;
553 dprintk("--> nfs_init_server()\n");
556 if (data->flags & NFS_MOUNT_VER3)
560 /* Allocate or find a client reference we can use */
561 clp = nfs_get_client(&cl_init);
563 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
567 error = nfs_init_client(clp, data);
571 server->nfs_client = clp;
573 /* Initialise the client representation from the mount data */
574 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
577 server->rsize = nfs_block_size(data->rsize, NULL);
579 server->wsize = nfs_block_size(data->wsize, NULL);
581 server->acregmin = data->acregmin * HZ;
582 server->acregmax = data->acregmax * HZ;
583 server->acdirmin = data->acdirmin * HZ;
584 server->acdirmax = data->acdirmax * HZ;
586 /* Start lockd here, before we might error out */
587 error = nfs_start_lockd(server);
591 error = nfs_init_server_rpcclient(server, data->auth_flavors[0]);
595 server->namelen = data->namlen;
596 /* Create a client RPC handle for the NFSv3 ACL management interface */
597 nfs_init_server_aclclient(server);
598 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
602 server->nfs_client = NULL;
604 dprintk("<-- nfs_init_server() = xerror %d\n", error);
609 * Load up the server record from information gained in an fsinfo record
611 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
613 unsigned long max_rpc_payload;
615 /* Work out a lot of parameters */
616 if (server->rsize == 0)
617 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
618 if (server->wsize == 0)
619 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
621 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
622 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
623 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
624 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
626 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
627 if (server->rsize > max_rpc_payload)
628 server->rsize = max_rpc_payload;
629 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
630 server->rsize = NFS_MAX_FILE_IO_SIZE;
631 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
633 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
635 if (server->wsize > max_rpc_payload)
636 server->wsize = max_rpc_payload;
637 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
638 server->wsize = NFS_MAX_FILE_IO_SIZE;
639 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
640 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
642 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
643 if (server->dtsize > PAGE_CACHE_SIZE)
644 server->dtsize = PAGE_CACHE_SIZE;
645 if (server->dtsize > server->rsize)
646 server->dtsize = server->rsize;
648 if (server->flags & NFS_MOUNT_NOAC) {
649 server->acregmin = server->acregmax = 0;
650 server->acdirmin = server->acdirmax = 0;
653 server->maxfilesize = fsinfo->maxfilesize;
655 /* We're airborne Set socket buffersize */
656 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
660 * Probe filesystem information, including the FSID on v2/v3
662 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
664 struct nfs_fsinfo fsinfo;
665 struct nfs_client *clp = server->nfs_client;
668 dprintk("--> nfs_probe_fsinfo()\n");
670 if (clp->rpc_ops->set_capabilities != NULL) {
671 error = clp->rpc_ops->set_capabilities(server, mntfh);
676 fsinfo.fattr = fattr;
677 nfs_fattr_init(fattr);
678 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
682 nfs_server_set_fsinfo(server, &fsinfo);
683 error = bdi_init(&server->backing_dev_info);
688 /* Get some general file system info */
689 if (server->namelen == 0) {
690 struct nfs_pathconf pathinfo;
692 pathinfo.fattr = fattr;
693 nfs_fattr_init(fattr);
695 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
696 server->namelen = pathinfo.max_namelen;
699 dprintk("<-- nfs_probe_fsinfo() = 0\n");
703 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
708 * Copy useful information when duplicating a server record
710 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
712 target->flags = source->flags;
713 target->acregmin = source->acregmin;
714 target->acregmax = source->acregmax;
715 target->acdirmin = source->acdirmin;
716 target->acdirmax = source->acdirmax;
717 target->caps = source->caps;
721 * Allocate and initialise a server record
723 static struct nfs_server *nfs_alloc_server(void)
725 struct nfs_server *server;
727 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
731 server->client = server->client_acl = ERR_PTR(-EINVAL);
733 /* Zero out the NFS state stuff */
734 INIT_LIST_HEAD(&server->client_link);
735 INIT_LIST_HEAD(&server->master_link);
737 init_waitqueue_head(&server->active_wq);
738 atomic_set(&server->active, 0);
740 server->io_stats = nfs_alloc_iostats();
741 if (!server->io_stats) {
750 * Free up a server record
752 void nfs_free_server(struct nfs_server *server)
754 dprintk("--> nfs_free_server()\n");
756 spin_lock(&nfs_client_lock);
757 list_del(&server->client_link);
758 list_del(&server->master_link);
759 spin_unlock(&nfs_client_lock);
761 if (server->destroy != NULL)
762 server->destroy(server);
764 if (!IS_ERR(server->client_acl))
765 rpc_shutdown_client(server->client_acl);
766 if (!IS_ERR(server->client))
767 rpc_shutdown_client(server->client);
769 nfs_put_client(server->nfs_client);
771 nfs_free_iostats(server->io_stats);
772 bdi_destroy(&server->backing_dev_info);
774 nfs_release_automount_timer();
775 dprintk("<-- nfs_free_server()\n");
779 * Create a version 2 or 3 volume record
780 * - keyed on server and FSID
782 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
783 struct nfs_fh *mntfh)
785 struct nfs_server *server;
786 struct nfs_fattr fattr;
789 server = nfs_alloc_server();
791 return ERR_PTR(-ENOMEM);
793 /* Get a client representation */
794 error = nfs_init_server(server, data);
798 BUG_ON(!server->nfs_client);
799 BUG_ON(!server->nfs_client->rpc_ops);
800 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
802 /* Probe the root fh to retrieve its FSID */
803 error = nfs_probe_fsinfo(server, mntfh, &fattr);
806 if (server->nfs_client->rpc_ops->version == 3) {
807 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
808 server->namelen = NFS3_MAXNAMLEN;
809 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
810 server->caps |= NFS_CAP_READDIRPLUS;
812 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
813 server->namelen = NFS2_MAXNAMLEN;
816 if (!(fattr.valid & NFS_ATTR_FATTR)) {
817 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
819 dprintk("nfs_create_server: getattr error = %d\n", -error);
823 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
825 dprintk("Server FSID: %llx:%llx\n",
826 (unsigned long long) server->fsid.major,
827 (unsigned long long) server->fsid.minor);
829 BUG_ON(!server->nfs_client);
830 BUG_ON(!server->nfs_client->rpc_ops);
831 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
833 spin_lock(&nfs_client_lock);
834 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
835 list_add_tail(&server->master_link, &nfs_volume_list);
836 spin_unlock(&nfs_client_lock);
838 server->mount_time = jiffies;
842 nfs_free_server(server);
843 return ERR_PTR(error);
848 * Initialise an NFS4 client record
850 static int nfs4_init_client(struct nfs_client *clp,
851 int proto, int timeo, int retrans,
853 rpc_authflavor_t authflavour)
857 if (clp->cl_cons_state == NFS_CS_READY) {
858 /* the client is initialised already */
859 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
863 /* Check NFS protocol revision and initialize RPC op vector */
864 clp->rpc_ops = &nfs_v4_clientops;
866 error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour,
867 RPC_CLNT_CREATE_DISCRTRY);
870 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
872 error = nfs_idmap_new(clp);
874 dprintk("%s: failed to create idmapper. Error = %d\n",
875 __FUNCTION__, error);
878 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
880 nfs_mark_client_ready(clp, NFS_CS_READY);
884 nfs_mark_client_ready(clp, error);
885 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
890 * Set up an NFS4 client
892 static int nfs4_set_client(struct nfs_server *server,
893 const char *hostname, const struct sockaddr_in *addr,
895 rpc_authflavor_t authflavour,
896 int proto, int timeo, int retrans)
898 struct nfs_client_initdata cl_init = {
899 .hostname = hostname,
903 struct nfs_client *clp;
906 dprintk("--> nfs4_set_client()\n");
908 /* Allocate or find a client reference we can use */
909 clp = nfs_get_client(&cl_init);
911 error = PTR_ERR(clp);
914 error = nfs4_init_client(clp, proto, timeo, retrans, ip_addr, authflavour);
918 server->nfs_client = clp;
919 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
925 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
930 * Create a version 4 volume record
932 static int nfs4_init_server(struct nfs_server *server,
933 const struct nfs_parsed_mount_data *data)
937 dprintk("--> nfs4_init_server()\n");
939 /* Initialise the client representation from the mount data */
940 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
941 server->caps |= NFS_CAP_ATOMIC_OPEN;
944 server->rsize = nfs_block_size(data->rsize, NULL);
946 server->wsize = nfs_block_size(data->wsize, NULL);
948 server->acregmin = data->acregmin * HZ;
949 server->acregmax = data->acregmax * HZ;
950 server->acdirmin = data->acdirmin * HZ;
951 server->acdirmax = data->acdirmax * HZ;
953 error = nfs_init_server_rpcclient(server, data->auth_flavors[0]);
956 dprintk("<-- nfs4_init_server() = %d\n", error);
961 * Create a version 4 volume record
962 * - keyed on server and FSID
964 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
965 struct nfs_fh *mntfh)
967 struct nfs_fattr fattr;
968 struct nfs_server *server;
971 dprintk("--> nfs4_create_server()\n");
973 server = nfs_alloc_server();
975 return ERR_PTR(-ENOMEM);
977 /* Get a client record */
978 error = nfs4_set_client(server,
979 data->nfs_server.hostname,
980 &data->nfs_server.address,
981 data->client_address,
982 data->auth_flavors[0],
983 data->nfs_server.protocol,
984 data->timeo, data->retrans);
988 /* set up the general RPC client */
989 error = nfs4_init_server(server, data);
993 BUG_ON(!server->nfs_client);
994 BUG_ON(!server->nfs_client->rpc_ops);
995 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
997 /* Probe the root fh to retrieve its FSID */
998 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1002 dprintk("Server FSID: %llx:%llx\n",
1003 (unsigned long long) server->fsid.major,
1004 (unsigned long long) server->fsid.minor);
1005 dprintk("Mount FH: %d\n", mntfh->size);
1007 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1011 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1012 server->namelen = NFS4_MAXNAMLEN;
1014 BUG_ON(!server->nfs_client);
1015 BUG_ON(!server->nfs_client->rpc_ops);
1016 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1018 spin_lock(&nfs_client_lock);
1019 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1020 list_add_tail(&server->master_link, &nfs_volume_list);
1021 spin_unlock(&nfs_client_lock);
1023 server->mount_time = jiffies;
1024 dprintk("<-- nfs4_create_server() = %p\n", server);
1028 nfs_free_server(server);
1029 dprintk("<-- nfs4_create_server() = error %d\n", error);
1030 return ERR_PTR(error);
1034 * Create an NFS4 referral server record
1036 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1037 struct nfs_fh *mntfh)
1039 struct nfs_client *parent_client;
1040 struct nfs_server *server, *parent_server;
1041 struct nfs_fattr fattr;
1044 dprintk("--> nfs4_create_referral_server()\n");
1046 server = nfs_alloc_server();
1048 return ERR_PTR(-ENOMEM);
1050 parent_server = NFS_SB(data->sb);
1051 parent_client = parent_server->nfs_client;
1053 /* Get a client representation.
1054 * Note: NFSv4 always uses TCP, */
1055 error = nfs4_set_client(server, data->hostname, data->addr,
1056 parent_client->cl_ipaddr,
1058 parent_server->client->cl_xprt->prot,
1059 parent_client->retrans_timeo,
1060 parent_client->retrans_count);
1064 /* Initialise the client representation from the parent server */
1065 nfs_server_copy_userdata(server, parent_server);
1066 server->caps |= NFS_CAP_ATOMIC_OPEN;
1068 error = nfs_init_server_rpcclient(server, data->authflavor);
1072 BUG_ON(!server->nfs_client);
1073 BUG_ON(!server->nfs_client->rpc_ops);
1074 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1076 /* Probe the root fh to retrieve its FSID and filehandle */
1077 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1081 /* probe the filesystem info for this server filesystem */
1082 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1086 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1087 server->namelen = NFS4_MAXNAMLEN;
1089 dprintk("Referral FSID: %llx:%llx\n",
1090 (unsigned long long) server->fsid.major,
1091 (unsigned long long) server->fsid.minor);
1093 spin_lock(&nfs_client_lock);
1094 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1095 list_add_tail(&server->master_link, &nfs_volume_list);
1096 spin_unlock(&nfs_client_lock);
1098 server->mount_time = jiffies;
1100 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1104 nfs_free_server(server);
1105 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1106 return ERR_PTR(error);
1109 #endif /* CONFIG_NFS_V4 */
1112 * Clone an NFS2, NFS3 or NFS4 server record
1114 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1116 struct nfs_fattr *fattr)
1118 struct nfs_server *server;
1119 struct nfs_fattr fattr_fsinfo;
1122 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1123 (unsigned long long) fattr->fsid.major,
1124 (unsigned long long) fattr->fsid.minor);
1126 server = nfs_alloc_server();
1128 return ERR_PTR(-ENOMEM);
1130 /* Copy data from the source */
1131 server->nfs_client = source->nfs_client;
1132 atomic_inc(&server->nfs_client->cl_count);
1133 nfs_server_copy_userdata(server, source);
1135 server->fsid = fattr->fsid;
1137 error = nfs_init_server_rpcclient(server, source->client->cl_auth->au_flavor);
1139 goto out_free_server;
1140 if (!IS_ERR(source->client_acl))
1141 nfs_init_server_aclclient(server);
1143 /* probe the filesystem info for this server filesystem */
1144 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1146 goto out_free_server;
1148 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1149 server->namelen = NFS4_MAXNAMLEN;
1151 dprintk("Cloned FSID: %llx:%llx\n",
1152 (unsigned long long) server->fsid.major,
1153 (unsigned long long) server->fsid.minor);
1155 error = nfs_start_lockd(server);
1157 goto out_free_server;
1159 spin_lock(&nfs_client_lock);
1160 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1161 list_add_tail(&server->master_link, &nfs_volume_list);
1162 spin_unlock(&nfs_client_lock);
1164 server->mount_time = jiffies;
1166 dprintk("<-- nfs_clone_server() = %p\n", server);
1170 nfs_free_server(server);
1171 dprintk("<-- nfs_clone_server() = error %d\n", error);
1172 return ERR_PTR(error);
1175 #ifdef CONFIG_PROC_FS
1176 static struct proc_dir_entry *proc_fs_nfs;
1178 static int nfs_server_list_open(struct inode *inode, struct file *file);
1179 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1180 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1181 static void nfs_server_list_stop(struct seq_file *p, void *v);
1182 static int nfs_server_list_show(struct seq_file *m, void *v);
1184 static struct seq_operations nfs_server_list_ops = {
1185 .start = nfs_server_list_start,
1186 .next = nfs_server_list_next,
1187 .stop = nfs_server_list_stop,
1188 .show = nfs_server_list_show,
1191 static const struct file_operations nfs_server_list_fops = {
1192 .open = nfs_server_list_open,
1194 .llseek = seq_lseek,
1195 .release = seq_release,
1198 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1199 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1200 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1201 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1202 static int nfs_volume_list_show(struct seq_file *m, void *v);
1204 static struct seq_operations nfs_volume_list_ops = {
1205 .start = nfs_volume_list_start,
1206 .next = nfs_volume_list_next,
1207 .stop = nfs_volume_list_stop,
1208 .show = nfs_volume_list_show,
1211 static const struct file_operations nfs_volume_list_fops = {
1212 .open = nfs_volume_list_open,
1214 .llseek = seq_lseek,
1215 .release = seq_release,
1219 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1222 static int nfs_server_list_open(struct inode *inode, struct file *file)
1227 ret = seq_open(file, &nfs_server_list_ops);
1231 m = file->private_data;
1232 m->private = PDE(inode)->data;
1238 * set up the iterator to start reading from the server list and return the first item
1240 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1242 /* lock the list against modification */
1243 spin_lock(&nfs_client_lock);
1244 return seq_list_start_head(&nfs_client_list, *_pos);
1248 * move to next server
1250 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1252 return seq_list_next(v, &nfs_client_list, pos);
1256 * clean up after reading from the transports list
1258 static void nfs_server_list_stop(struct seq_file *p, void *v)
1260 spin_unlock(&nfs_client_lock);
1264 * display a header line followed by a load of call lines
1266 static int nfs_server_list_show(struct seq_file *m, void *v)
1268 struct nfs_client *clp;
1270 /* display header on line 1 */
1271 if (v == &nfs_client_list) {
1272 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1276 /* display one transport per line on subsequent lines */
1277 clp = list_entry(v, struct nfs_client, cl_share_link);
1279 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %3d %s\n",
1281 NIPQUAD(clp->cl_addr.sin_addr),
1282 ntohs(clp->cl_addr.sin_port),
1283 atomic_read(&clp->cl_count),
1290 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1292 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1297 ret = seq_open(file, &nfs_volume_list_ops);
1301 m = file->private_data;
1302 m->private = PDE(inode)->data;
1308 * set up the iterator to start reading from the volume list and return the first item
1310 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1312 /* lock the list against modification */
1313 spin_lock(&nfs_client_lock);
1314 return seq_list_start_head(&nfs_volume_list, *_pos);
1318 * move to next volume
1320 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1322 return seq_list_next(v, &nfs_volume_list, pos);
1326 * clean up after reading from the transports list
1328 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1330 spin_unlock(&nfs_client_lock);
1334 * display a header line followed by a load of call lines
1336 static int nfs_volume_list_show(struct seq_file *m, void *v)
1338 struct nfs_server *server;
1339 struct nfs_client *clp;
1340 char dev[8], fsid[17];
1342 /* display header on line 1 */
1343 if (v == &nfs_volume_list) {
1344 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1347 /* display one transport per line on subsequent lines */
1348 server = list_entry(v, struct nfs_server, master_link);
1349 clp = server->nfs_client;
1351 snprintf(dev, 8, "%u:%u",
1352 MAJOR(server->s_dev), MINOR(server->s_dev));
1354 snprintf(fsid, 17, "%llx:%llx",
1355 (unsigned long long) server->fsid.major,
1356 (unsigned long long) server->fsid.minor);
1358 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %-7s %-17s\n",
1360 NIPQUAD(clp->cl_addr.sin_addr),
1361 ntohs(clp->cl_addr.sin_port),
1369 * initialise the /proc/fs/nfsfs/ directory
1371 int __init nfs_fs_proc_init(void)
1373 struct proc_dir_entry *p;
1375 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1379 proc_fs_nfs->owner = THIS_MODULE;
1381 /* a file of servers with which we're dealing */
1382 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1386 p->proc_fops = &nfs_server_list_fops;
1387 p->owner = THIS_MODULE;
1389 /* a file of volumes that we have mounted */
1390 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1394 p->proc_fops = &nfs_volume_list_fops;
1395 p->owner = THIS_MODULE;
1399 remove_proc_entry("servers", proc_fs_nfs);
1401 remove_proc_entry("nfsfs", proc_root_fs);
1407 * clean up the /proc/fs/nfsfs/ directory
1409 void nfs_fs_proc_exit(void)
1411 remove_proc_entry("volumes", proc_fs_nfs);
1412 remove_proc_entry("servers", proc_fs_nfs);
1413 remove_proc_entry("nfsfs", proc_root_fs);
1416 #endif /* CONFIG_PROC_FS */