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/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;
107 * Allocate a shared client record
109 * Since these are allocated/deallocated very rarely, we don't
110 * bother putting them in a slab cache...
112 static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
114 struct nfs_client *clp;
116 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
119 clp->rpc_ops = cl_init->rpc_ops;
121 if (cl_init->rpc_ops->version == 4) {
122 if (nfs_callback_up() < 0)
124 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
127 atomic_set(&clp->cl_count, 1);
128 clp->cl_cons_state = NFS_CS_INITING;
130 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
131 clp->cl_addrlen = cl_init->addrlen;
133 if (cl_init->hostname) {
134 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
135 if (!clp->cl_hostname)
139 INIT_LIST_HEAD(&clp->cl_superblocks);
140 clp->cl_rpcclient = ERR_PTR(-EINVAL);
142 clp->cl_proto = cl_init->proto;
145 init_rwsem(&clp->cl_sem);
146 INIT_LIST_HEAD(&clp->cl_delegations);
147 spin_lock_init(&clp->cl_lock);
148 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
149 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
150 clp->cl_boot_time = CURRENT_TIME;
151 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
157 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
165 static void nfs4_shutdown_client(struct nfs_client *clp)
168 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
169 nfs4_kill_renewd(clp);
170 BUG_ON(!RB_EMPTY_ROOT(&clp->cl_state_owners));
171 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
172 nfs_idmap_delete(clp);
177 * Destroy a shared client record
179 static void nfs_free_client(struct nfs_client *clp)
181 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
183 nfs4_shutdown_client(clp);
185 /* -EIO all pending I/O */
186 if (!IS_ERR(clp->cl_rpcclient))
187 rpc_shutdown_client(clp->cl_rpcclient);
189 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
192 kfree(clp->cl_hostname);
195 dprintk("<-- nfs_free_client()\n");
199 * Release a reference to a shared client record
201 void nfs_put_client(struct nfs_client *clp)
206 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
208 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
209 list_del(&clp->cl_share_link);
210 spin_unlock(&nfs_client_lock);
212 BUG_ON(!list_empty(&clp->cl_superblocks));
214 nfs_free_client(clp);
218 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr_in *sa1,
219 const struct sockaddr_in *sa2)
221 return sa1->sin_addr.s_addr == sa2->sin_addr.s_addr;
224 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr_in6 *sa1,
225 const struct sockaddr_in6 *sa2)
227 return ipv6_addr_equal(&sa1->sin6_addr, &sa2->sin6_addr);
230 static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
231 const struct sockaddr *sa2)
233 switch (sa1->sa_family) {
235 return nfs_sockaddr_match_ipaddr4((const struct sockaddr_in *)sa1,
236 (const struct sockaddr_in *)sa2);
238 return nfs_sockaddr_match_ipaddr6((const struct sockaddr_in6 *)sa1,
239 (const struct sockaddr_in6 *)sa2);
245 * Find a client by IP address and protocol version
246 * - returns NULL if no such client
248 struct nfs_client *nfs_find_client(const struct sockaddr *addr, u32 nfsversion)
250 struct nfs_client *clp;
252 spin_lock(&nfs_client_lock);
253 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
254 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
256 /* Don't match clients that failed to initialise properly */
257 if (clp->cl_cons_state != NFS_CS_READY)
260 /* Different NFS versions cannot share the same nfs_client */
261 if (clp->rpc_ops->version != nfsversion)
264 if (addr->sa_family != clap->sa_family)
266 /* Match only the IP address, not the port number */
267 if (!nfs_sockaddr_match_ipaddr(addr, clap))
270 atomic_inc(&clp->cl_count);
271 spin_unlock(&nfs_client_lock);
274 spin_unlock(&nfs_client_lock);
279 * Find a client by IP address and protocol version
280 * - returns NULL if no such client
282 struct nfs_client *nfs_find_client_next(struct nfs_client *clp)
284 struct sockaddr *sap = (struct sockaddr *)&clp->cl_addr;
285 u32 nfsvers = clp->rpc_ops->version;
287 spin_lock(&nfs_client_lock);
288 list_for_each_entry_continue(clp, &nfs_client_list, cl_share_link) {
289 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
291 /* Don't match clients that failed to initialise properly */
292 if (clp->cl_cons_state != NFS_CS_READY)
295 /* Different NFS versions cannot share the same nfs_client */
296 if (clp->rpc_ops->version != nfsvers)
299 if (sap->sa_family != clap->sa_family)
301 /* Match only the IP address, not the port number */
302 if (!nfs_sockaddr_match_ipaddr(sap, clap))
305 atomic_inc(&clp->cl_count);
306 spin_unlock(&nfs_client_lock);
309 spin_unlock(&nfs_client_lock);
314 * Find an nfs_client on the list that matches the initialisation data
317 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
319 struct nfs_client *clp;
321 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
322 /* Don't match clients that failed to initialise properly */
323 if (clp->cl_cons_state < 0)
326 /* Different NFS versions cannot share the same nfs_client */
327 if (clp->rpc_ops != data->rpc_ops)
330 if (clp->cl_proto != data->proto)
333 /* Match the full socket address */
334 if (memcmp(&clp->cl_addr, data->addr, sizeof(clp->cl_addr)) != 0)
337 atomic_inc(&clp->cl_count);
344 * Look up a client by IP address and protocol version
345 * - creates a new record if one doesn't yet exist
347 static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
349 struct nfs_client *clp, *new = NULL;
352 dprintk("--> nfs_get_client(%s,v%u)\n",
353 cl_init->hostname ?: "", cl_init->rpc_ops->version);
355 /* see if the client already exists */
357 spin_lock(&nfs_client_lock);
359 clp = nfs_match_client(cl_init);
365 spin_unlock(&nfs_client_lock);
367 new = nfs_alloc_client(cl_init);
370 return ERR_PTR(-ENOMEM);
372 /* install a new client and return with it unready */
375 list_add(&clp->cl_share_link, &nfs_client_list);
376 spin_unlock(&nfs_client_lock);
377 dprintk("--> nfs_get_client() = %p [new]\n", clp);
380 /* found an existing client
381 * - make sure it's ready before returning
384 spin_unlock(&nfs_client_lock);
387 nfs_free_client(new);
389 error = wait_event_killable(nfs_client_active_wq,
390 clp->cl_cons_state != NFS_CS_INITING);
393 return ERR_PTR(-ERESTARTSYS);
396 if (clp->cl_cons_state < NFS_CS_READY) {
397 error = clp->cl_cons_state;
399 return ERR_PTR(error);
402 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
404 dprintk("--> nfs_get_client() = %p [share]\n", clp);
409 * Mark a server as ready or failed
411 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
413 clp->cl_cons_state = state;
414 wake_up_all(&nfs_client_active_wq);
418 * Initialise the timeout values for a connection
420 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
421 unsigned int timeo, unsigned int retrans)
423 to->to_initval = timeo * HZ / 10;
424 to->to_retries = retrans;
429 case XPRT_TRANSPORT_TCP:
430 case XPRT_TRANSPORT_RDMA:
431 if (to->to_initval == 0)
432 to->to_initval = 60 * HZ;
433 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
434 to->to_initval = NFS_MAX_TCP_TIMEOUT;
435 to->to_increment = to->to_initval;
436 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
437 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
438 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
439 if (to->to_maxval < to->to_initval)
440 to->to_maxval = to->to_initval;
441 to->to_exponential = 0;
443 case XPRT_TRANSPORT_UDP:
446 to->to_initval = 11 * HZ / 10;
447 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
448 to->to_initval = NFS_MAX_UDP_TIMEOUT;
449 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
450 to->to_exponential = 1;
456 * Create an RPC client handle
458 static int nfs_create_rpc_client(struct nfs_client *clp,
459 const struct rpc_timeout *timeparms,
460 rpc_authflavor_t flavor,
463 struct rpc_clnt *clnt = NULL;
464 struct rpc_create_args args = {
465 .protocol = clp->cl_proto,
466 .address = (struct sockaddr *)&clp->cl_addr,
467 .addrsize = clp->cl_addrlen,
468 .timeout = timeparms,
469 .servername = clp->cl_hostname,
470 .program = &nfs_program,
471 .version = clp->rpc_ops->version,
472 .authflavor = flavor,
476 if (!IS_ERR(clp->cl_rpcclient))
479 clnt = rpc_create(&args);
481 dprintk("%s: cannot create RPC client. Error = %ld\n",
482 __FUNCTION__, PTR_ERR(clnt));
483 return PTR_ERR(clnt);
486 clp->cl_rpcclient = clnt;
491 * Version 2 or 3 client destruction
493 static void nfs_destroy_server(struct nfs_server *server)
495 if (!(server->flags & NFS_MOUNT_NONLM))
496 nlmclnt_done(server->nlm_host);
500 * Version 2 or 3 lockd setup
502 static int nfs_start_lockd(struct nfs_server *server)
504 struct nlm_host *host;
505 struct nfs_client *clp = server->nfs_client;
506 struct nlmclnt_initdata nlm_init = {
507 .hostname = clp->cl_hostname,
508 .address = (struct sockaddr *)&clp->cl_addr,
509 .addrlen = clp->cl_addrlen,
510 .protocol = server->flags & NFS_MOUNT_TCP ?
511 IPPROTO_TCP : IPPROTO_UDP,
512 .nfs_version = clp->rpc_ops->version,
515 if (nlm_init.nfs_version > 3)
517 if (server->flags & NFS_MOUNT_NONLM)
520 host = nlmclnt_init(&nlm_init);
522 return PTR_ERR(host);
524 server->nlm_host = host;
525 server->destroy = nfs_destroy_server;
530 * Initialise an NFSv3 ACL client connection
532 #ifdef CONFIG_NFS_V3_ACL
533 static void nfs_init_server_aclclient(struct nfs_server *server)
535 if (server->nfs_client->rpc_ops->version != 3)
537 if (server->flags & NFS_MOUNT_NOACL)
540 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
541 if (IS_ERR(server->client_acl))
544 /* No errors! Assume that Sun nfsacls are supported */
545 server->caps |= NFS_CAP_ACLS;
549 server->caps &= ~NFS_CAP_ACLS;
552 static inline void nfs_init_server_aclclient(struct nfs_server *server)
554 server->flags &= ~NFS_MOUNT_NOACL;
555 server->caps &= ~NFS_CAP_ACLS;
560 * Create a general RPC client
562 static int nfs_init_server_rpcclient(struct nfs_server *server,
563 const struct rpc_timeout *timeo,
564 rpc_authflavor_t pseudoflavour)
566 struct nfs_client *clp = server->nfs_client;
568 server->client = rpc_clone_client(clp->cl_rpcclient);
569 if (IS_ERR(server->client)) {
570 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
571 return PTR_ERR(server->client);
574 memcpy(&server->client->cl_timeout_default,
576 sizeof(server->client->cl_timeout_default));
577 server->client->cl_timeout = &server->client->cl_timeout_default;
579 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
580 struct rpc_auth *auth;
582 auth = rpcauth_create(pseudoflavour, server->client);
584 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
585 return PTR_ERR(auth);
588 server->client->cl_softrtry = 0;
589 if (server->flags & NFS_MOUNT_SOFT)
590 server->client->cl_softrtry = 1;
596 * Initialise an NFS2 or NFS3 client
598 static int nfs_init_client(struct nfs_client *clp,
599 const struct rpc_timeout *timeparms,
600 const struct nfs_parsed_mount_data *data)
604 if (clp->cl_cons_state == NFS_CS_READY) {
605 /* the client is already initialised */
606 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
611 * Create a client RPC handle for doing FSSTAT with UNIX auth only
612 * - RFC 2623, sec 2.3.2
614 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX, 0);
617 nfs_mark_client_ready(clp, NFS_CS_READY);
621 nfs_mark_client_ready(clp, error);
622 dprintk("<-- nfs_init_client() = xerror %d\n", error);
627 * Create a version 2 or 3 client
629 static int nfs_init_server(struct nfs_server *server,
630 const struct nfs_parsed_mount_data *data)
632 struct nfs_client_initdata cl_init = {
633 .hostname = data->nfs_server.hostname,
634 .addr = (const struct sockaddr *)&data->nfs_server.address,
635 .addrlen = data->nfs_server.addrlen,
636 .rpc_ops = &nfs_v2_clientops,
637 .proto = data->nfs_server.protocol,
639 struct rpc_timeout timeparms;
640 struct nfs_client *clp;
643 dprintk("--> nfs_init_server()\n");
646 if (data->flags & NFS_MOUNT_VER3)
647 cl_init.rpc_ops = &nfs_v3_clientops;
650 /* Allocate or find a client reference we can use */
651 clp = nfs_get_client(&cl_init);
653 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
657 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
658 data->timeo, data->retrans);
659 error = nfs_init_client(clp, &timeparms, data);
663 server->nfs_client = clp;
665 /* Initialise the client representation from the mount data */
666 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
669 server->rsize = nfs_block_size(data->rsize, NULL);
671 server->wsize = nfs_block_size(data->wsize, NULL);
673 server->acregmin = data->acregmin * HZ;
674 server->acregmax = data->acregmax * HZ;
675 server->acdirmin = data->acdirmin * HZ;
676 server->acdirmax = data->acdirmax * HZ;
678 /* Start lockd here, before we might error out */
679 error = nfs_start_lockd(server);
683 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
687 server->namelen = data->namlen;
688 /* Create a client RPC handle for the NFSv3 ACL management interface */
689 nfs_init_server_aclclient(server);
690 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
694 server->nfs_client = NULL;
696 dprintk("<-- nfs_init_server() = xerror %d\n", error);
701 * Load up the server record from information gained in an fsinfo record
703 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
705 unsigned long max_rpc_payload;
707 /* Work out a lot of parameters */
708 if (server->rsize == 0)
709 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
710 if (server->wsize == 0)
711 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
713 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
714 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
715 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
716 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
718 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
719 if (server->rsize > max_rpc_payload)
720 server->rsize = max_rpc_payload;
721 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
722 server->rsize = NFS_MAX_FILE_IO_SIZE;
723 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
725 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
727 if (server->wsize > max_rpc_payload)
728 server->wsize = max_rpc_payload;
729 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
730 server->wsize = NFS_MAX_FILE_IO_SIZE;
731 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
732 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
734 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
735 if (server->dtsize > PAGE_CACHE_SIZE)
736 server->dtsize = PAGE_CACHE_SIZE;
737 if (server->dtsize > server->rsize)
738 server->dtsize = server->rsize;
740 if (server->flags & NFS_MOUNT_NOAC) {
741 server->acregmin = server->acregmax = 0;
742 server->acdirmin = server->acdirmax = 0;
745 server->maxfilesize = fsinfo->maxfilesize;
747 /* We're airborne Set socket buffersize */
748 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
752 * Probe filesystem information, including the FSID on v2/v3
754 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
756 struct nfs_fsinfo fsinfo;
757 struct nfs_client *clp = server->nfs_client;
760 dprintk("--> nfs_probe_fsinfo()\n");
762 if (clp->rpc_ops->set_capabilities != NULL) {
763 error = clp->rpc_ops->set_capabilities(server, mntfh);
768 fsinfo.fattr = fattr;
769 nfs_fattr_init(fattr);
770 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
774 nfs_server_set_fsinfo(server, &fsinfo);
775 error = bdi_init(&server->backing_dev_info);
780 /* Get some general file system info */
781 if (server->namelen == 0) {
782 struct nfs_pathconf pathinfo;
784 pathinfo.fattr = fattr;
785 nfs_fattr_init(fattr);
787 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
788 server->namelen = pathinfo.max_namelen;
791 dprintk("<-- nfs_probe_fsinfo() = 0\n");
795 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
800 * Copy useful information when duplicating a server record
802 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
804 target->flags = source->flags;
805 target->acregmin = source->acregmin;
806 target->acregmax = source->acregmax;
807 target->acdirmin = source->acdirmin;
808 target->acdirmax = source->acdirmax;
809 target->caps = source->caps;
813 * Allocate and initialise a server record
815 static struct nfs_server *nfs_alloc_server(void)
817 struct nfs_server *server;
819 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
823 server->client = server->client_acl = ERR_PTR(-EINVAL);
825 /* Zero out the NFS state stuff */
826 INIT_LIST_HEAD(&server->client_link);
827 INIT_LIST_HEAD(&server->master_link);
829 init_waitqueue_head(&server->active_wq);
830 atomic_set(&server->active, 0);
832 server->io_stats = nfs_alloc_iostats();
833 if (!server->io_stats) {
842 * Free up a server record
844 void nfs_free_server(struct nfs_server *server)
846 dprintk("--> nfs_free_server()\n");
848 spin_lock(&nfs_client_lock);
849 list_del(&server->client_link);
850 list_del(&server->master_link);
851 spin_unlock(&nfs_client_lock);
853 if (server->destroy != NULL)
854 server->destroy(server);
856 if (!IS_ERR(server->client_acl))
857 rpc_shutdown_client(server->client_acl);
858 if (!IS_ERR(server->client))
859 rpc_shutdown_client(server->client);
861 nfs_put_client(server->nfs_client);
863 nfs_free_iostats(server->io_stats);
864 bdi_destroy(&server->backing_dev_info);
866 nfs_release_automount_timer();
867 dprintk("<-- nfs_free_server()\n");
871 * Create a version 2 or 3 volume record
872 * - keyed on server and FSID
874 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
875 struct nfs_fh *mntfh)
877 struct nfs_server *server;
878 struct nfs_fattr fattr;
881 server = nfs_alloc_server();
883 return ERR_PTR(-ENOMEM);
885 /* Get a client representation */
886 error = nfs_init_server(server, data);
890 BUG_ON(!server->nfs_client);
891 BUG_ON(!server->nfs_client->rpc_ops);
892 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
894 /* Probe the root fh to retrieve its FSID */
895 error = nfs_probe_fsinfo(server, mntfh, &fattr);
898 if (server->nfs_client->rpc_ops->version == 3) {
899 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
900 server->namelen = NFS3_MAXNAMLEN;
901 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
902 server->caps |= NFS_CAP_READDIRPLUS;
904 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
905 server->namelen = NFS2_MAXNAMLEN;
908 if (!(fattr.valid & NFS_ATTR_FATTR)) {
909 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
911 dprintk("nfs_create_server: getattr error = %d\n", -error);
915 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
917 dprintk("Server FSID: %llx:%llx\n",
918 (unsigned long long) server->fsid.major,
919 (unsigned long long) server->fsid.minor);
921 BUG_ON(!server->nfs_client);
922 BUG_ON(!server->nfs_client->rpc_ops);
923 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
925 spin_lock(&nfs_client_lock);
926 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
927 list_add_tail(&server->master_link, &nfs_volume_list);
928 spin_unlock(&nfs_client_lock);
930 server->mount_time = jiffies;
934 nfs_free_server(server);
935 return ERR_PTR(error);
940 * Initialise an NFS4 client record
942 static int nfs4_init_client(struct nfs_client *clp,
943 const struct rpc_timeout *timeparms,
945 rpc_authflavor_t authflavour)
949 if (clp->cl_cons_state == NFS_CS_READY) {
950 /* the client is initialised already */
951 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
955 /* Check NFS protocol revision and initialize RPC op vector */
956 clp->rpc_ops = &nfs_v4_clientops;
958 error = nfs_create_rpc_client(clp, timeparms, authflavour,
959 RPC_CLNT_CREATE_DISCRTRY);
962 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
964 error = nfs_idmap_new(clp);
966 dprintk("%s: failed to create idmapper. Error = %d\n",
967 __FUNCTION__, error);
970 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
972 nfs_mark_client_ready(clp, NFS_CS_READY);
976 nfs_mark_client_ready(clp, error);
977 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
982 * Set up an NFS4 client
984 static int nfs4_set_client(struct nfs_server *server,
985 const char *hostname,
986 const struct sockaddr *addr,
987 const size_t addrlen,
989 rpc_authflavor_t authflavour,
990 int proto, const struct rpc_timeout *timeparms)
992 struct nfs_client_initdata cl_init = {
993 .hostname = hostname,
996 .rpc_ops = &nfs_v4_clientops,
999 struct nfs_client *clp;
1002 dprintk("--> nfs4_set_client()\n");
1004 /* Allocate or find a client reference we can use */
1005 clp = nfs_get_client(&cl_init);
1007 error = PTR_ERR(clp);
1010 error = nfs4_init_client(clp, timeparms, ip_addr, authflavour);
1014 server->nfs_client = clp;
1015 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
1019 nfs_put_client(clp);
1021 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
1026 * Create a version 4 volume record
1028 static int nfs4_init_server(struct nfs_server *server,
1029 const struct nfs_parsed_mount_data *data)
1031 struct rpc_timeout timeparms;
1034 dprintk("--> nfs4_init_server()\n");
1036 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1037 data->timeo, data->retrans);
1039 /* Get a client record */
1040 error = nfs4_set_client(server,
1041 data->nfs_server.hostname,
1042 (const struct sockaddr *)&data->nfs_server.address,
1043 data->nfs_server.addrlen,
1044 data->client_address,
1045 data->auth_flavors[0],
1046 data->nfs_server.protocol,
1051 /* Initialise the client representation from the mount data */
1052 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
1053 server->caps |= NFS_CAP_ATOMIC_OPEN;
1056 server->rsize = nfs_block_size(data->rsize, NULL);
1058 server->wsize = nfs_block_size(data->wsize, NULL);
1060 server->acregmin = data->acregmin * HZ;
1061 server->acregmax = data->acregmax * HZ;
1062 server->acdirmin = data->acdirmin * HZ;
1063 server->acdirmax = data->acdirmax * HZ;
1065 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1069 dprintk("<-- nfs4_init_server() = %d\n", error);
1074 * Create a version 4 volume record
1075 * - keyed on server and FSID
1077 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1078 struct nfs_fh *mntfh)
1080 struct nfs_fattr fattr;
1081 struct nfs_server *server;
1084 dprintk("--> nfs4_create_server()\n");
1086 server = nfs_alloc_server();
1088 return ERR_PTR(-ENOMEM);
1090 /* set up the general RPC client */
1091 error = nfs4_init_server(server, data);
1095 BUG_ON(!server->nfs_client);
1096 BUG_ON(!server->nfs_client->rpc_ops);
1097 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1099 /* Probe the root fh to retrieve its FSID */
1100 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1104 dprintk("Server FSID: %llx:%llx\n",
1105 (unsigned long long) server->fsid.major,
1106 (unsigned long long) server->fsid.minor);
1107 dprintk("Mount FH: %d\n", mntfh->size);
1109 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1113 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1114 server->namelen = NFS4_MAXNAMLEN;
1116 BUG_ON(!server->nfs_client);
1117 BUG_ON(!server->nfs_client->rpc_ops);
1118 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1120 spin_lock(&nfs_client_lock);
1121 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1122 list_add_tail(&server->master_link, &nfs_volume_list);
1123 spin_unlock(&nfs_client_lock);
1125 server->mount_time = jiffies;
1126 dprintk("<-- nfs4_create_server() = %p\n", server);
1130 nfs_free_server(server);
1131 dprintk("<-- nfs4_create_server() = error %d\n", error);
1132 return ERR_PTR(error);
1136 * Create an NFS4 referral server record
1138 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1139 struct nfs_fh *mntfh)
1141 struct nfs_client *parent_client;
1142 struct nfs_server *server, *parent_server;
1143 struct nfs_fattr fattr;
1146 dprintk("--> nfs4_create_referral_server()\n");
1148 server = nfs_alloc_server();
1150 return ERR_PTR(-ENOMEM);
1152 parent_server = NFS_SB(data->sb);
1153 parent_client = parent_server->nfs_client;
1155 /* Get a client representation.
1156 * Note: NFSv4 always uses TCP, */
1157 error = nfs4_set_client(server, data->hostname,
1160 parent_client->cl_ipaddr,
1162 parent_server->client->cl_xprt->prot,
1163 parent_server->client->cl_timeout);
1167 /* Initialise the client representation from the parent server */
1168 nfs_server_copy_userdata(server, parent_server);
1169 server->caps |= NFS_CAP_ATOMIC_OPEN;
1171 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1175 BUG_ON(!server->nfs_client);
1176 BUG_ON(!server->nfs_client->rpc_ops);
1177 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1179 /* Probe the root fh to retrieve its FSID and filehandle */
1180 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1184 /* probe the filesystem info for this server filesystem */
1185 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1189 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1190 server->namelen = NFS4_MAXNAMLEN;
1192 dprintk("Referral FSID: %llx:%llx\n",
1193 (unsigned long long) server->fsid.major,
1194 (unsigned long long) server->fsid.minor);
1196 spin_lock(&nfs_client_lock);
1197 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1198 list_add_tail(&server->master_link, &nfs_volume_list);
1199 spin_unlock(&nfs_client_lock);
1201 server->mount_time = jiffies;
1203 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1207 nfs_free_server(server);
1208 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1209 return ERR_PTR(error);
1212 #endif /* CONFIG_NFS_V4 */
1215 * Clone an NFS2, NFS3 or NFS4 server record
1217 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1219 struct nfs_fattr *fattr)
1221 struct nfs_server *server;
1222 struct nfs_fattr fattr_fsinfo;
1225 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1226 (unsigned long long) fattr->fsid.major,
1227 (unsigned long long) fattr->fsid.minor);
1229 server = nfs_alloc_server();
1231 return ERR_PTR(-ENOMEM);
1233 /* Copy data from the source */
1234 server->nfs_client = source->nfs_client;
1235 atomic_inc(&server->nfs_client->cl_count);
1236 nfs_server_copy_userdata(server, source);
1238 server->fsid = fattr->fsid;
1240 error = nfs_init_server_rpcclient(server,
1241 source->client->cl_timeout,
1242 source->client->cl_auth->au_flavor);
1244 goto out_free_server;
1245 if (!IS_ERR(source->client_acl))
1246 nfs_init_server_aclclient(server);
1248 /* probe the filesystem info for this server filesystem */
1249 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1251 goto out_free_server;
1253 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1254 server->namelen = NFS4_MAXNAMLEN;
1256 dprintk("Cloned FSID: %llx:%llx\n",
1257 (unsigned long long) server->fsid.major,
1258 (unsigned long long) server->fsid.minor);
1260 error = nfs_start_lockd(server);
1262 goto out_free_server;
1264 spin_lock(&nfs_client_lock);
1265 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1266 list_add_tail(&server->master_link, &nfs_volume_list);
1267 spin_unlock(&nfs_client_lock);
1269 server->mount_time = jiffies;
1271 dprintk("<-- nfs_clone_server() = %p\n", server);
1275 nfs_free_server(server);
1276 dprintk("<-- nfs_clone_server() = error %d\n", error);
1277 return ERR_PTR(error);
1280 #ifdef CONFIG_PROC_FS
1281 static struct proc_dir_entry *proc_fs_nfs;
1283 static int nfs_server_list_open(struct inode *inode, struct file *file);
1284 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1285 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1286 static void nfs_server_list_stop(struct seq_file *p, void *v);
1287 static int nfs_server_list_show(struct seq_file *m, void *v);
1289 static struct seq_operations nfs_server_list_ops = {
1290 .start = nfs_server_list_start,
1291 .next = nfs_server_list_next,
1292 .stop = nfs_server_list_stop,
1293 .show = nfs_server_list_show,
1296 static const struct file_operations nfs_server_list_fops = {
1297 .open = nfs_server_list_open,
1299 .llseek = seq_lseek,
1300 .release = seq_release,
1303 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1304 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1305 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1306 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1307 static int nfs_volume_list_show(struct seq_file *m, void *v);
1309 static struct seq_operations nfs_volume_list_ops = {
1310 .start = nfs_volume_list_start,
1311 .next = nfs_volume_list_next,
1312 .stop = nfs_volume_list_stop,
1313 .show = nfs_volume_list_show,
1316 static const struct file_operations nfs_volume_list_fops = {
1317 .open = nfs_volume_list_open,
1319 .llseek = seq_lseek,
1320 .release = seq_release,
1324 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1327 static int nfs_server_list_open(struct inode *inode, struct file *file)
1332 ret = seq_open(file, &nfs_server_list_ops);
1336 m = file->private_data;
1337 m->private = PDE(inode)->data;
1343 * set up the iterator to start reading from the server list and return the first item
1345 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1347 /* lock the list against modification */
1348 spin_lock(&nfs_client_lock);
1349 return seq_list_start_head(&nfs_client_list, *_pos);
1353 * move to next server
1355 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1357 return seq_list_next(v, &nfs_client_list, pos);
1361 * clean up after reading from the transports list
1363 static void nfs_server_list_stop(struct seq_file *p, void *v)
1365 spin_unlock(&nfs_client_lock);
1369 * display a header line followed by a load of call lines
1371 static int nfs_server_list_show(struct seq_file *m, void *v)
1373 struct nfs_client *clp;
1375 /* display header on line 1 */
1376 if (v == &nfs_client_list) {
1377 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1381 /* display one transport per line on subsequent lines */
1382 clp = list_entry(v, struct nfs_client, cl_share_link);
1384 seq_printf(m, "v%u %s %s %3d %s\n",
1385 clp->rpc_ops->version,
1386 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1387 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1388 atomic_read(&clp->cl_count),
1395 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1397 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1402 ret = seq_open(file, &nfs_volume_list_ops);
1406 m = file->private_data;
1407 m->private = PDE(inode)->data;
1413 * set up the iterator to start reading from the volume list and return the first item
1415 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1417 /* lock the list against modification */
1418 spin_lock(&nfs_client_lock);
1419 return seq_list_start_head(&nfs_volume_list, *_pos);
1423 * move to next volume
1425 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1427 return seq_list_next(v, &nfs_volume_list, pos);
1431 * clean up after reading from the transports list
1433 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1435 spin_unlock(&nfs_client_lock);
1439 * display a header line followed by a load of call lines
1441 static int nfs_volume_list_show(struct seq_file *m, void *v)
1443 struct nfs_server *server;
1444 struct nfs_client *clp;
1445 char dev[8], fsid[17];
1447 /* display header on line 1 */
1448 if (v == &nfs_volume_list) {
1449 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1452 /* display one transport per line on subsequent lines */
1453 server = list_entry(v, struct nfs_server, master_link);
1454 clp = server->nfs_client;
1456 snprintf(dev, 8, "%u:%u",
1457 MAJOR(server->s_dev), MINOR(server->s_dev));
1459 snprintf(fsid, 17, "%llx:%llx",
1460 (unsigned long long) server->fsid.major,
1461 (unsigned long long) server->fsid.minor);
1463 seq_printf(m, "v%u %s %s %-7s %-17s\n",
1464 clp->rpc_ops->version,
1465 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1466 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1474 * initialise the /proc/fs/nfsfs/ directory
1476 int __init nfs_fs_proc_init(void)
1478 struct proc_dir_entry *p;
1480 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1484 proc_fs_nfs->owner = THIS_MODULE;
1486 /* a file of servers with which we're dealing */
1487 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1491 p->proc_fops = &nfs_server_list_fops;
1492 p->owner = THIS_MODULE;
1494 /* a file of volumes that we have mounted */
1495 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1499 p->proc_fops = &nfs_volume_list_fops;
1500 p->owner = THIS_MODULE;
1504 remove_proc_entry("servers", proc_fs_nfs);
1506 remove_proc_entry("nfsfs", proc_root_fs);
1512 * clean up the /proc/fs/nfsfs/ directory
1514 void nfs_fs_proc_exit(void)
1516 remove_proc_entry("volumes", proc_fs_nfs);
1517 remove_proc_entry("servers", proc_fs_nfs);
1518 remove_proc_entry("nfsfs", proc_root_fs);
1521 #endif /* CONFIG_PROC_FS */