1 /* client.c: NFS client sharing and management code
3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
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/in6.h>
39 #include <linux/nfs_xdr.h>
41 #include <asm/system.h>
45 #include "delegation.h"
49 #define NFSDBG_FACILITY NFSDBG_CLIENT
51 static DEFINE_SPINLOCK(nfs_client_lock);
52 static LIST_HEAD(nfs_client_list);
53 static LIST_HEAD(nfs_volume_list);
54 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
59 static struct rpc_version *nfs_version[5] = {
69 struct rpc_program nfs_program = {
71 .number = NFS_PROGRAM,
72 .nrvers = ARRAY_SIZE(nfs_version),
73 .version = nfs_version,
74 .stats = &nfs_rpcstat,
75 .pipe_dir_name = "/nfs",
78 struct rpc_stat nfs_rpcstat = {
79 .program = &nfs_program
83 #ifdef CONFIG_NFS_V3_ACL
84 static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
85 static struct rpc_version * nfsacl_version[] = {
86 [3] = &nfsacl_version3,
89 struct rpc_program nfsacl_program = {
91 .number = NFS_ACL_PROGRAM,
92 .nrvers = ARRAY_SIZE(nfsacl_version),
93 .version = nfsacl_version,
94 .stats = &nfsacl_rpcstat,
96 #endif /* CONFIG_NFS_V3_ACL */
98 struct nfs_client_initdata {
100 const struct sockaddr *addr;
102 const struct nfs_rpc_ops *rpc_ops;
106 * Allocate a shared client record
108 * Since these are allocated/deallocated very rarely, we don't
109 * bother putting them in a slab cache...
111 static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
113 struct nfs_client *clp;
115 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
118 clp->rpc_ops = cl_init->rpc_ops;
120 if (cl_init->rpc_ops->version == 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 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
130 clp->cl_addrlen = cl_init->addrlen;
132 if (cl_init->hostname) {
133 clp->cl_hostname = kstrdup(cl_init->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 spin_lock_init(&clp->cl_lock);
145 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
146 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
147 clp->cl_boot_time = CURRENT_TIME;
148 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
154 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
162 static void nfs4_shutdown_client(struct nfs_client *clp)
165 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
166 nfs4_kill_renewd(clp);
167 BUG_ON(!RB_EMPTY_ROOT(&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(%u)\n", clp->rpc_ops->version);
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);
215 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr_in *sa1,
216 const struct sockaddr_in *sa2)
218 return sa1->sin_addr.s_addr == sa2->sin_addr.s_addr;
221 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr_in6 *sa1,
222 const struct sockaddr_in6 *sa2)
224 return ipv6_addr_equal(&sa1->sin6_addr, &sa2->sin6_addr);
227 static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
228 const struct sockaddr *sa2)
230 switch (sa1->sa_family) {
232 return nfs_sockaddr_match_ipaddr4((const struct sockaddr_in *)sa1,
233 (const struct sockaddr_in *)sa2);
235 return nfs_sockaddr_match_ipaddr6((const struct sockaddr_in6 *)sa1,
236 (const struct sockaddr_in6 *)sa2);
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 *addr, u32 nfsversion)
247 struct nfs_client *clp;
249 spin_lock(&nfs_client_lock);
250 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
251 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
253 /* Don't match clients that failed to initialise properly */
254 if (clp->cl_cons_state != NFS_CS_READY)
257 /* Different NFS versions cannot share the same nfs_client */
258 if (clp->rpc_ops->version != nfsversion)
261 if (addr->sa_family != clap->sa_family)
263 /* Match only the IP address, not the port number */
264 if (!nfs_sockaddr_match_ipaddr(addr, clap))
267 atomic_inc(&clp->cl_count);
268 spin_unlock(&nfs_client_lock);
271 spin_unlock(&nfs_client_lock);
276 * Find an nfs_client on the list that matches the initialisation data
279 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
281 struct nfs_client *clp;
283 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
284 /* Don't match clients that failed to initialise properly */
285 if (clp->cl_cons_state < 0)
288 /* Different NFS versions cannot share the same nfs_client */
289 if (clp->rpc_ops != data->rpc_ops)
292 /* Match the full socket address */
293 if (memcmp(&clp->cl_addr, data->addr, sizeof(clp->cl_addr)) != 0)
296 atomic_inc(&clp->cl_count);
303 * Look up a client by IP address and protocol version
304 * - creates a new record if one doesn't yet exist
306 static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
308 struct nfs_client *clp, *new = NULL;
311 dprintk("--> nfs_get_client(%s,v%u)\n",
312 cl_init->hostname ?: "", cl_init->rpc_ops->version);
314 /* see if the client already exists */
316 spin_lock(&nfs_client_lock);
318 clp = nfs_match_client(cl_init);
324 spin_unlock(&nfs_client_lock);
326 new = nfs_alloc_client(cl_init);
329 return ERR_PTR(-ENOMEM);
331 /* install a new client and return with it unready */
334 list_add(&clp->cl_share_link, &nfs_client_list);
335 spin_unlock(&nfs_client_lock);
336 dprintk("--> nfs_get_client() = %p [new]\n", clp);
339 /* found an existing client
340 * - make sure it's ready before returning
343 spin_unlock(&nfs_client_lock);
346 nfs_free_client(new);
348 error = wait_event_interruptible(nfs_client_active_wq,
349 clp->cl_cons_state != NFS_CS_INITING);
352 return ERR_PTR(-ERESTARTSYS);
355 if (clp->cl_cons_state < NFS_CS_READY) {
356 error = clp->cl_cons_state;
358 return ERR_PTR(error);
361 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
363 dprintk("--> nfs_get_client() = %p [share]\n", clp);
368 * Mark a server as ready or failed
370 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
372 clp->cl_cons_state = state;
373 wake_up_all(&nfs_client_active_wq);
377 * Initialise the timeout values for a connection
379 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
380 unsigned int timeo, unsigned int retrans)
382 to->to_initval = timeo * HZ / 10;
383 to->to_retries = retrans;
388 case XPRT_TRANSPORT_TCP:
389 case XPRT_TRANSPORT_RDMA:
390 if (to->to_initval == 0)
391 to->to_initval = 60 * HZ;
392 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
393 to->to_initval = NFS_MAX_TCP_TIMEOUT;
394 to->to_increment = to->to_initval;
395 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
396 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
397 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
398 if (to->to_maxval < to->to_initval)
399 to->to_maxval = to->to_initval;
400 to->to_exponential = 0;
402 case XPRT_TRANSPORT_UDP:
405 to->to_initval = 11 * HZ / 10;
406 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
407 to->to_initval = NFS_MAX_UDP_TIMEOUT;
408 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
409 to->to_exponential = 1;
415 * Create an RPC client handle
417 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
419 unsigned int retrans,
420 rpc_authflavor_t flavor,
423 struct rpc_timeout timeparms;
424 struct rpc_clnt *clnt = NULL;
425 struct rpc_create_args args = {
427 .address = (struct sockaddr *)&clp->cl_addr,
428 .addrsize = clp->cl_addrlen,
429 .timeout = &timeparms,
430 .servername = clp->cl_hostname,
431 .program = &nfs_program,
432 .version = clp->rpc_ops->version,
433 .authflavor = flavor,
437 if (!IS_ERR(clp->cl_rpcclient))
440 nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
441 clp->retrans_timeo = timeparms.to_initval;
442 clp->retrans_count = timeparms.to_retries;
444 clnt = rpc_create(&args);
446 dprintk("%s: cannot create RPC client. Error = %ld\n",
447 __FUNCTION__, PTR_ERR(clnt));
448 return PTR_ERR(clnt);
451 clp->cl_rpcclient = clnt;
456 * Version 2 or 3 client destruction
458 static void nfs_destroy_server(struct nfs_server *server)
460 if (!(server->flags & NFS_MOUNT_NONLM))
461 lockd_down(); /* release rpc.lockd */
465 * Version 2 or 3 lockd setup
467 static int nfs_start_lockd(struct nfs_server *server)
471 if (server->nfs_client->rpc_ops->version > 3)
473 if (server->flags & NFS_MOUNT_NONLM)
475 error = lockd_up((server->flags & NFS_MOUNT_TCP) ?
476 IPPROTO_TCP : IPPROTO_UDP);
478 server->flags |= NFS_MOUNT_NONLM;
480 server->destroy = nfs_destroy_server;
486 * Initialise an NFSv3 ACL client connection
488 #ifdef CONFIG_NFS_V3_ACL
489 static void nfs_init_server_aclclient(struct nfs_server *server)
491 if (server->nfs_client->rpc_ops->version != 3)
493 if (server->flags & NFS_MOUNT_NOACL)
496 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
497 if (IS_ERR(server->client_acl))
500 /* No errors! Assume that Sun nfsacls are supported */
501 server->caps |= NFS_CAP_ACLS;
505 server->caps &= ~NFS_CAP_ACLS;
508 static inline void nfs_init_server_aclclient(struct nfs_server *server)
510 server->flags &= ~NFS_MOUNT_NOACL;
511 server->caps &= ~NFS_CAP_ACLS;
516 * Create a general RPC client
518 static int nfs_init_server_rpcclient(struct nfs_server *server, rpc_authflavor_t pseudoflavour)
520 struct nfs_client *clp = server->nfs_client;
522 server->client = rpc_clone_client(clp->cl_rpcclient);
523 if (IS_ERR(server->client)) {
524 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
525 return PTR_ERR(server->client);
528 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
529 struct rpc_auth *auth;
531 auth = rpcauth_create(pseudoflavour, server->client);
533 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
534 return PTR_ERR(auth);
537 server->client->cl_softrtry = 0;
538 if (server->flags & NFS_MOUNT_SOFT)
539 server->client->cl_softrtry = 1;
541 server->client->cl_intr = 0;
542 if (server->flags & NFS4_MOUNT_INTR)
543 server->client->cl_intr = 1;
549 * Initialise an NFS2 or NFS3 client
551 static int nfs_init_client(struct nfs_client *clp,
552 const struct nfs_parsed_mount_data *data)
556 if (clp->cl_cons_state == NFS_CS_READY) {
557 /* the client is already initialised */
558 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
563 * Create a client RPC handle for doing FSSTAT with UNIX auth only
564 * - RFC 2623, sec 2.3.2
566 error = nfs_create_rpc_client(clp, data->nfs_server.protocol,
567 data->timeo, data->retrans, RPC_AUTH_UNIX, 0);
570 nfs_mark_client_ready(clp, NFS_CS_READY);
574 nfs_mark_client_ready(clp, error);
575 dprintk("<-- nfs_init_client() = xerror %d\n", error);
580 * Create a version 2 or 3 client
582 static int nfs_init_server(struct nfs_server *server,
583 const struct nfs_parsed_mount_data *data)
585 struct nfs_client_initdata cl_init = {
586 .hostname = data->nfs_server.hostname,
587 .addr = (const struct sockaddr *)&data->nfs_server.address,
588 .addrlen = data->nfs_server.addrlen,
589 .rpc_ops = &nfs_v2_clientops,
591 struct nfs_client *clp;
594 dprintk("--> nfs_init_server()\n");
597 if (data->flags & NFS_MOUNT_VER3)
598 cl_init.rpc_ops = &nfs_v3_clientops;
601 /* Allocate or find a client reference we can use */
602 clp = nfs_get_client(&cl_init);
604 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
608 error = nfs_init_client(clp, data);
612 server->nfs_client = clp;
614 /* Initialise the client representation from the mount data */
615 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
618 server->rsize = nfs_block_size(data->rsize, NULL);
620 server->wsize = nfs_block_size(data->wsize, NULL);
622 server->acregmin = data->acregmin * HZ;
623 server->acregmax = data->acregmax * HZ;
624 server->acdirmin = data->acdirmin * HZ;
625 server->acdirmax = data->acdirmax * HZ;
627 /* Start lockd here, before we might error out */
628 error = nfs_start_lockd(server);
632 error = nfs_init_server_rpcclient(server, data->auth_flavors[0]);
636 server->namelen = data->namlen;
637 /* Create a client RPC handle for the NFSv3 ACL management interface */
638 nfs_init_server_aclclient(server);
639 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
643 server->nfs_client = NULL;
645 dprintk("<-- nfs_init_server() = xerror %d\n", error);
650 * Load up the server record from information gained in an fsinfo record
652 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
654 unsigned long max_rpc_payload;
656 /* Work out a lot of parameters */
657 if (server->rsize == 0)
658 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
659 if (server->wsize == 0)
660 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
662 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
663 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
664 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
665 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
667 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
668 if (server->rsize > max_rpc_payload)
669 server->rsize = max_rpc_payload;
670 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
671 server->rsize = NFS_MAX_FILE_IO_SIZE;
672 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
674 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
676 if (server->wsize > max_rpc_payload)
677 server->wsize = max_rpc_payload;
678 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
679 server->wsize = NFS_MAX_FILE_IO_SIZE;
680 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
681 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
683 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
684 if (server->dtsize > PAGE_CACHE_SIZE)
685 server->dtsize = PAGE_CACHE_SIZE;
686 if (server->dtsize > server->rsize)
687 server->dtsize = server->rsize;
689 if (server->flags & NFS_MOUNT_NOAC) {
690 server->acregmin = server->acregmax = 0;
691 server->acdirmin = server->acdirmax = 0;
694 server->maxfilesize = fsinfo->maxfilesize;
696 /* We're airborne Set socket buffersize */
697 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
701 * Probe filesystem information, including the FSID on v2/v3
703 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
705 struct nfs_fsinfo fsinfo;
706 struct nfs_client *clp = server->nfs_client;
709 dprintk("--> nfs_probe_fsinfo()\n");
711 if (clp->rpc_ops->set_capabilities != NULL) {
712 error = clp->rpc_ops->set_capabilities(server, mntfh);
717 fsinfo.fattr = fattr;
718 nfs_fattr_init(fattr);
719 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
723 nfs_server_set_fsinfo(server, &fsinfo);
724 error = bdi_init(&server->backing_dev_info);
729 /* Get some general file system info */
730 if (server->namelen == 0) {
731 struct nfs_pathconf pathinfo;
733 pathinfo.fattr = fattr;
734 nfs_fattr_init(fattr);
736 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
737 server->namelen = pathinfo.max_namelen;
740 dprintk("<-- nfs_probe_fsinfo() = 0\n");
744 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
749 * Copy useful information when duplicating a server record
751 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
753 target->flags = source->flags;
754 target->acregmin = source->acregmin;
755 target->acregmax = source->acregmax;
756 target->acdirmin = source->acdirmin;
757 target->acdirmax = source->acdirmax;
758 target->caps = source->caps;
762 * Allocate and initialise a server record
764 static struct nfs_server *nfs_alloc_server(void)
766 struct nfs_server *server;
768 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
772 server->client = server->client_acl = ERR_PTR(-EINVAL);
774 /* Zero out the NFS state stuff */
775 INIT_LIST_HEAD(&server->client_link);
776 INIT_LIST_HEAD(&server->master_link);
778 init_waitqueue_head(&server->active_wq);
779 atomic_set(&server->active, 0);
781 server->io_stats = nfs_alloc_iostats();
782 if (!server->io_stats) {
791 * Free up a server record
793 void nfs_free_server(struct nfs_server *server)
795 dprintk("--> nfs_free_server()\n");
797 spin_lock(&nfs_client_lock);
798 list_del(&server->client_link);
799 list_del(&server->master_link);
800 spin_unlock(&nfs_client_lock);
802 if (server->destroy != NULL)
803 server->destroy(server);
805 if (!IS_ERR(server->client_acl))
806 rpc_shutdown_client(server->client_acl);
807 if (!IS_ERR(server->client))
808 rpc_shutdown_client(server->client);
810 nfs_put_client(server->nfs_client);
812 nfs_free_iostats(server->io_stats);
813 bdi_destroy(&server->backing_dev_info);
815 nfs_release_automount_timer();
816 dprintk("<-- nfs_free_server()\n");
820 * Create a version 2 or 3 volume record
821 * - keyed on server and FSID
823 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
824 struct nfs_fh *mntfh)
826 struct nfs_server *server;
827 struct nfs_fattr fattr;
830 server = nfs_alloc_server();
832 return ERR_PTR(-ENOMEM);
834 /* Get a client representation */
835 error = nfs_init_server(server, data);
839 BUG_ON(!server->nfs_client);
840 BUG_ON(!server->nfs_client->rpc_ops);
841 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
843 /* Probe the root fh to retrieve its FSID */
844 error = nfs_probe_fsinfo(server, mntfh, &fattr);
847 if (server->nfs_client->rpc_ops->version == 3) {
848 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
849 server->namelen = NFS3_MAXNAMLEN;
850 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
851 server->caps |= NFS_CAP_READDIRPLUS;
853 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
854 server->namelen = NFS2_MAXNAMLEN;
857 if (!(fattr.valid & NFS_ATTR_FATTR)) {
858 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
860 dprintk("nfs_create_server: getattr error = %d\n", -error);
864 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
866 dprintk("Server FSID: %llx:%llx\n",
867 (unsigned long long) server->fsid.major,
868 (unsigned long long) server->fsid.minor);
870 BUG_ON(!server->nfs_client);
871 BUG_ON(!server->nfs_client->rpc_ops);
872 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
874 spin_lock(&nfs_client_lock);
875 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
876 list_add_tail(&server->master_link, &nfs_volume_list);
877 spin_unlock(&nfs_client_lock);
879 server->mount_time = jiffies;
883 nfs_free_server(server);
884 return ERR_PTR(error);
889 * Initialise an NFS4 client record
891 static int nfs4_init_client(struct nfs_client *clp,
892 int proto, int timeo, int retrans,
894 rpc_authflavor_t authflavour)
898 if (clp->cl_cons_state == NFS_CS_READY) {
899 /* the client is initialised already */
900 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
904 /* Check NFS protocol revision and initialize RPC op vector */
905 clp->rpc_ops = &nfs_v4_clientops;
907 error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour,
908 RPC_CLNT_CREATE_DISCRTRY);
911 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
913 error = nfs_idmap_new(clp);
915 dprintk("%s: failed to create idmapper. Error = %d\n",
916 __FUNCTION__, error);
919 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
921 nfs_mark_client_ready(clp, NFS_CS_READY);
925 nfs_mark_client_ready(clp, error);
926 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
931 * Set up an NFS4 client
933 static int nfs4_set_client(struct nfs_server *server,
934 const char *hostname,
935 const struct sockaddr *addr,
936 const size_t addrlen,
938 rpc_authflavor_t authflavour,
939 int proto, int timeo, int retrans)
941 struct nfs_client_initdata cl_init = {
942 .hostname = hostname,
945 .rpc_ops = &nfs_v4_clientops,
947 struct nfs_client *clp;
950 dprintk("--> nfs4_set_client()\n");
952 /* Allocate or find a client reference we can use */
953 clp = nfs_get_client(&cl_init);
955 error = PTR_ERR(clp);
958 error = nfs4_init_client(clp, proto, timeo, retrans, ip_addr, authflavour);
962 server->nfs_client = clp;
963 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
969 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
974 * Create a version 4 volume record
976 static int nfs4_init_server(struct nfs_server *server,
977 const struct nfs_parsed_mount_data *data)
981 dprintk("--> nfs4_init_server()\n");
983 /* Initialise the client representation from the mount data */
984 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
985 server->caps |= NFS_CAP_ATOMIC_OPEN;
988 server->rsize = nfs_block_size(data->rsize, NULL);
990 server->wsize = nfs_block_size(data->wsize, NULL);
992 server->acregmin = data->acregmin * HZ;
993 server->acregmax = data->acregmax * HZ;
994 server->acdirmin = data->acdirmin * HZ;
995 server->acdirmax = data->acdirmax * HZ;
997 error = nfs_init_server_rpcclient(server, data->auth_flavors[0]);
1000 dprintk("<-- nfs4_init_server() = %d\n", error);
1005 * Create a version 4 volume record
1006 * - keyed on server and FSID
1008 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1009 struct nfs_fh *mntfh)
1011 struct nfs_fattr fattr;
1012 struct nfs_server *server;
1015 dprintk("--> nfs4_create_server()\n");
1017 server = nfs_alloc_server();
1019 return ERR_PTR(-ENOMEM);
1021 /* Get a client record */
1022 error = nfs4_set_client(server,
1023 data->nfs_server.hostname,
1024 (struct sockaddr *)&data->nfs_server.address,
1025 data->nfs_server.addrlen,
1026 data->client_address,
1027 data->auth_flavors[0],
1028 data->nfs_server.protocol,
1029 data->timeo, data->retrans);
1033 /* set up the general RPC client */
1034 error = nfs4_init_server(server, data);
1038 BUG_ON(!server->nfs_client);
1039 BUG_ON(!server->nfs_client->rpc_ops);
1040 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1042 /* Probe the root fh to retrieve its FSID */
1043 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1047 dprintk("Server FSID: %llx:%llx\n",
1048 (unsigned long long) server->fsid.major,
1049 (unsigned long long) server->fsid.minor);
1050 dprintk("Mount FH: %d\n", mntfh->size);
1052 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1056 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1057 server->namelen = NFS4_MAXNAMLEN;
1059 BUG_ON(!server->nfs_client);
1060 BUG_ON(!server->nfs_client->rpc_ops);
1061 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1063 spin_lock(&nfs_client_lock);
1064 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1065 list_add_tail(&server->master_link, &nfs_volume_list);
1066 spin_unlock(&nfs_client_lock);
1068 server->mount_time = jiffies;
1069 dprintk("<-- nfs4_create_server() = %p\n", server);
1073 nfs_free_server(server);
1074 dprintk("<-- nfs4_create_server() = error %d\n", error);
1075 return ERR_PTR(error);
1079 * Create an NFS4 referral server record
1081 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1082 struct nfs_fh *mntfh)
1084 struct nfs_client *parent_client;
1085 struct nfs_server *server, *parent_server;
1086 struct nfs_fattr fattr;
1089 dprintk("--> nfs4_create_referral_server()\n");
1091 server = nfs_alloc_server();
1093 return ERR_PTR(-ENOMEM);
1095 parent_server = NFS_SB(data->sb);
1096 parent_client = parent_server->nfs_client;
1098 /* Get a client representation.
1099 * Note: NFSv4 always uses TCP, */
1100 error = nfs4_set_client(server, data->hostname,
1103 parent_client->cl_ipaddr,
1105 parent_server->client->cl_xprt->prot,
1106 parent_client->retrans_timeo,
1107 parent_client->retrans_count);
1111 /* Initialise the client representation from the parent server */
1112 nfs_server_copy_userdata(server, parent_server);
1113 server->caps |= NFS_CAP_ATOMIC_OPEN;
1115 error = nfs_init_server_rpcclient(server, data->authflavor);
1119 BUG_ON(!server->nfs_client);
1120 BUG_ON(!server->nfs_client->rpc_ops);
1121 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1123 /* Probe the root fh to retrieve its FSID and filehandle */
1124 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1128 /* probe the filesystem info for this server filesystem */
1129 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1133 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1134 server->namelen = NFS4_MAXNAMLEN;
1136 dprintk("Referral FSID: %llx:%llx\n",
1137 (unsigned long long) server->fsid.major,
1138 (unsigned long long) server->fsid.minor);
1140 spin_lock(&nfs_client_lock);
1141 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1142 list_add_tail(&server->master_link, &nfs_volume_list);
1143 spin_unlock(&nfs_client_lock);
1145 server->mount_time = jiffies;
1147 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1151 nfs_free_server(server);
1152 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1153 return ERR_PTR(error);
1156 #endif /* CONFIG_NFS_V4 */
1159 * Clone an NFS2, NFS3 or NFS4 server record
1161 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1163 struct nfs_fattr *fattr)
1165 struct nfs_server *server;
1166 struct nfs_fattr fattr_fsinfo;
1169 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1170 (unsigned long long) fattr->fsid.major,
1171 (unsigned long long) fattr->fsid.minor);
1173 server = nfs_alloc_server();
1175 return ERR_PTR(-ENOMEM);
1177 /* Copy data from the source */
1178 server->nfs_client = source->nfs_client;
1179 atomic_inc(&server->nfs_client->cl_count);
1180 nfs_server_copy_userdata(server, source);
1182 server->fsid = fattr->fsid;
1184 error = nfs_init_server_rpcclient(server, source->client->cl_auth->au_flavor);
1186 goto out_free_server;
1187 if (!IS_ERR(source->client_acl))
1188 nfs_init_server_aclclient(server);
1190 /* probe the filesystem info for this server filesystem */
1191 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1193 goto out_free_server;
1195 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1196 server->namelen = NFS4_MAXNAMLEN;
1198 dprintk("Cloned FSID: %llx:%llx\n",
1199 (unsigned long long) server->fsid.major,
1200 (unsigned long long) server->fsid.minor);
1202 error = nfs_start_lockd(server);
1204 goto out_free_server;
1206 spin_lock(&nfs_client_lock);
1207 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1208 list_add_tail(&server->master_link, &nfs_volume_list);
1209 spin_unlock(&nfs_client_lock);
1211 server->mount_time = jiffies;
1213 dprintk("<-- nfs_clone_server() = %p\n", server);
1217 nfs_free_server(server);
1218 dprintk("<-- nfs_clone_server() = error %d\n", error);
1219 return ERR_PTR(error);
1222 #ifdef CONFIG_PROC_FS
1223 static struct proc_dir_entry *proc_fs_nfs;
1225 static int nfs_server_list_open(struct inode *inode, struct file *file);
1226 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1227 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1228 static void nfs_server_list_stop(struct seq_file *p, void *v);
1229 static int nfs_server_list_show(struct seq_file *m, void *v);
1231 static struct seq_operations nfs_server_list_ops = {
1232 .start = nfs_server_list_start,
1233 .next = nfs_server_list_next,
1234 .stop = nfs_server_list_stop,
1235 .show = nfs_server_list_show,
1238 static const struct file_operations nfs_server_list_fops = {
1239 .open = nfs_server_list_open,
1241 .llseek = seq_lseek,
1242 .release = seq_release,
1245 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1246 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1247 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1248 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1249 static int nfs_volume_list_show(struct seq_file *m, void *v);
1251 static struct seq_operations nfs_volume_list_ops = {
1252 .start = nfs_volume_list_start,
1253 .next = nfs_volume_list_next,
1254 .stop = nfs_volume_list_stop,
1255 .show = nfs_volume_list_show,
1258 static const struct file_operations nfs_volume_list_fops = {
1259 .open = nfs_volume_list_open,
1261 .llseek = seq_lseek,
1262 .release = seq_release,
1266 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1269 static int nfs_server_list_open(struct inode *inode, struct file *file)
1274 ret = seq_open(file, &nfs_server_list_ops);
1278 m = file->private_data;
1279 m->private = PDE(inode)->data;
1285 * set up the iterator to start reading from the server list and return the first item
1287 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1289 /* lock the list against modification */
1290 spin_lock(&nfs_client_lock);
1291 return seq_list_start_head(&nfs_client_list, *_pos);
1295 * move to next server
1297 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1299 return seq_list_next(v, &nfs_client_list, pos);
1303 * clean up after reading from the transports list
1305 static void nfs_server_list_stop(struct seq_file *p, void *v)
1307 spin_unlock(&nfs_client_lock);
1311 * display a header line followed by a load of call lines
1313 static int nfs_server_list_show(struct seq_file *m, void *v)
1315 struct nfs_client *clp;
1317 /* display header on line 1 */
1318 if (v == &nfs_client_list) {
1319 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1323 /* display one transport per line on subsequent lines */
1324 clp = list_entry(v, struct nfs_client, cl_share_link);
1326 seq_printf(m, "v%u %s %s %3d %s\n",
1327 clp->rpc_ops->version,
1328 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1329 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1330 atomic_read(&clp->cl_count),
1337 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1339 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1344 ret = seq_open(file, &nfs_volume_list_ops);
1348 m = file->private_data;
1349 m->private = PDE(inode)->data;
1355 * set up the iterator to start reading from the volume list and return the first item
1357 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1359 /* lock the list against modification */
1360 spin_lock(&nfs_client_lock);
1361 return seq_list_start_head(&nfs_volume_list, *_pos);
1365 * move to next volume
1367 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1369 return seq_list_next(v, &nfs_volume_list, pos);
1373 * clean up after reading from the transports list
1375 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1377 spin_unlock(&nfs_client_lock);
1381 * display a header line followed by a load of call lines
1383 static int nfs_volume_list_show(struct seq_file *m, void *v)
1385 struct nfs_server *server;
1386 struct nfs_client *clp;
1387 char dev[8], fsid[17];
1389 /* display header on line 1 */
1390 if (v == &nfs_volume_list) {
1391 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1394 /* display one transport per line on subsequent lines */
1395 server = list_entry(v, struct nfs_server, master_link);
1396 clp = server->nfs_client;
1398 snprintf(dev, 8, "%u:%u",
1399 MAJOR(server->s_dev), MINOR(server->s_dev));
1401 snprintf(fsid, 17, "%llx:%llx",
1402 (unsigned long long) server->fsid.major,
1403 (unsigned long long) server->fsid.minor);
1405 seq_printf(m, "v%u %s %s %-7s %-17s\n",
1406 clp->rpc_ops->version,
1407 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1408 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1416 * initialise the /proc/fs/nfsfs/ directory
1418 int __init nfs_fs_proc_init(void)
1420 struct proc_dir_entry *p;
1422 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1426 proc_fs_nfs->owner = THIS_MODULE;
1428 /* a file of servers with which we're dealing */
1429 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1433 p->proc_fops = &nfs_server_list_fops;
1434 p->owner = THIS_MODULE;
1436 /* a file of volumes that we have mounted */
1437 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1441 p->proc_fops = &nfs_volume_list_fops;
1442 p->owner = THIS_MODULE;
1446 remove_proc_entry("servers", proc_fs_nfs);
1448 remove_proc_entry("nfsfs", proc_root_fs);
1454 * clean up the /proc/fs/nfsfs/ directory
1456 void nfs_fs_proc_exit(void)
1458 remove_proc_entry("volumes", proc_fs_nfs);
1459 remove_proc_entry("servers", proc_fs_nfs);
1460 remove_proc_entry("nfsfs", proc_root_fs);
1463 #endif /* CONFIG_PROC_FS */