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 an nfs_client on the list that matches the initialisation data
282 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
284 struct nfs_client *clp;
286 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
287 /* Don't match clients that failed to initialise properly */
288 if (clp->cl_cons_state < 0)
291 /* Different NFS versions cannot share the same nfs_client */
292 if (clp->rpc_ops != data->rpc_ops)
295 if (clp->cl_proto != data->proto)
298 /* Match the full socket address */
299 if (memcmp(&clp->cl_addr, data->addr, sizeof(clp->cl_addr)) != 0)
302 atomic_inc(&clp->cl_count);
309 * Look up a client by IP address and protocol version
310 * - creates a new record if one doesn't yet exist
312 static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
314 struct nfs_client *clp, *new = NULL;
317 dprintk("--> nfs_get_client(%s,v%u)\n",
318 cl_init->hostname ?: "", cl_init->rpc_ops->version);
320 /* see if the client already exists */
322 spin_lock(&nfs_client_lock);
324 clp = nfs_match_client(cl_init);
330 spin_unlock(&nfs_client_lock);
332 new = nfs_alloc_client(cl_init);
335 return ERR_PTR(-ENOMEM);
337 /* install a new client and return with it unready */
340 list_add(&clp->cl_share_link, &nfs_client_list);
341 spin_unlock(&nfs_client_lock);
342 dprintk("--> nfs_get_client() = %p [new]\n", clp);
345 /* found an existing client
346 * - make sure it's ready before returning
349 spin_unlock(&nfs_client_lock);
352 nfs_free_client(new);
354 error = wait_event_interruptible(nfs_client_active_wq,
355 clp->cl_cons_state != NFS_CS_INITING);
358 return ERR_PTR(-ERESTARTSYS);
361 if (clp->cl_cons_state < NFS_CS_READY) {
362 error = clp->cl_cons_state;
364 return ERR_PTR(error);
367 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
369 dprintk("--> nfs_get_client() = %p [share]\n", clp);
374 * Mark a server as ready or failed
376 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
378 clp->cl_cons_state = state;
379 wake_up_all(&nfs_client_active_wq);
383 * Initialise the timeout values for a connection
385 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
386 unsigned int timeo, unsigned int retrans)
388 to->to_initval = timeo * HZ / 10;
389 to->to_retries = retrans;
394 case XPRT_TRANSPORT_TCP:
395 case XPRT_TRANSPORT_RDMA:
396 if (to->to_initval == 0)
397 to->to_initval = 60 * HZ;
398 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
399 to->to_initval = NFS_MAX_TCP_TIMEOUT;
400 to->to_increment = to->to_initval;
401 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
402 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
403 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
404 if (to->to_maxval < to->to_initval)
405 to->to_maxval = to->to_initval;
406 to->to_exponential = 0;
408 case XPRT_TRANSPORT_UDP:
411 to->to_initval = 11 * HZ / 10;
412 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
413 to->to_initval = NFS_MAX_UDP_TIMEOUT;
414 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
415 to->to_exponential = 1;
421 * Create an RPC client handle
423 static int nfs_create_rpc_client(struct nfs_client *clp,
424 const struct rpc_timeout *timeparms,
425 rpc_authflavor_t flavor,
428 struct rpc_clnt *clnt = NULL;
429 struct rpc_create_args args = {
430 .protocol = clp->cl_proto,
431 .address = (struct sockaddr *)&clp->cl_addr,
432 .addrsize = clp->cl_addrlen,
433 .timeout = timeparms,
434 .servername = clp->cl_hostname,
435 .program = &nfs_program,
436 .version = clp->rpc_ops->version,
437 .authflavor = flavor,
441 if (!IS_ERR(clp->cl_rpcclient))
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 nlmclnt_done(server->nlm_host);
465 * Version 2 or 3 lockd setup
467 static int nfs_start_lockd(struct nfs_server *server)
469 struct nlm_host *host;
470 struct nfs_client *clp = server->nfs_client;
471 struct nlmclnt_initdata nlm_init = {
472 .hostname = clp->cl_hostname,
473 .address = (struct sockaddr *)&clp->cl_addr,
474 .addrlen = clp->cl_addrlen,
475 .protocol = server->flags & NFS_MOUNT_TCP ?
476 IPPROTO_TCP : IPPROTO_UDP,
477 .nfs_version = clp->rpc_ops->version,
480 if (nlm_init.nfs_version > 3)
482 if (server->flags & NFS_MOUNT_NONLM)
485 host = nlmclnt_init(&nlm_init);
487 return PTR_ERR(host);
489 server->nlm_host = host;
490 server->destroy = nfs_destroy_server;
495 * Initialise an NFSv3 ACL client connection
497 #ifdef CONFIG_NFS_V3_ACL
498 static void nfs_init_server_aclclient(struct nfs_server *server)
500 if (server->nfs_client->rpc_ops->version != 3)
502 if (server->flags & NFS_MOUNT_NOACL)
505 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
506 if (IS_ERR(server->client_acl))
509 /* No errors! Assume that Sun nfsacls are supported */
510 server->caps |= NFS_CAP_ACLS;
514 server->caps &= ~NFS_CAP_ACLS;
517 static inline void nfs_init_server_aclclient(struct nfs_server *server)
519 server->flags &= ~NFS_MOUNT_NOACL;
520 server->caps &= ~NFS_CAP_ACLS;
525 * Create a general RPC client
527 static int nfs_init_server_rpcclient(struct nfs_server *server,
528 const struct rpc_timeout *timeo,
529 rpc_authflavor_t pseudoflavour)
531 struct nfs_client *clp = server->nfs_client;
533 server->client = rpc_clone_client(clp->cl_rpcclient);
534 if (IS_ERR(server->client)) {
535 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
536 return PTR_ERR(server->client);
539 memcpy(&server->client->cl_timeout_default,
541 sizeof(server->client->cl_timeout_default));
542 server->client->cl_timeout = &server->client->cl_timeout_default;
544 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
545 struct rpc_auth *auth;
547 auth = rpcauth_create(pseudoflavour, server->client);
549 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
550 return PTR_ERR(auth);
553 server->client->cl_softrtry = 0;
554 if (server->flags & NFS_MOUNT_SOFT)
555 server->client->cl_softrtry = 1;
557 server->client->cl_intr = 0;
558 if (server->flags & NFS4_MOUNT_INTR)
559 server->client->cl_intr = 1;
565 * Initialise an NFS2 or NFS3 client
567 static int nfs_init_client(struct nfs_client *clp,
568 const struct rpc_timeout *timeparms,
569 const struct nfs_parsed_mount_data *data)
573 if (clp->cl_cons_state == NFS_CS_READY) {
574 /* the client is already initialised */
575 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
580 * Create a client RPC handle for doing FSSTAT with UNIX auth only
581 * - RFC 2623, sec 2.3.2
583 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX, 0);
586 nfs_mark_client_ready(clp, NFS_CS_READY);
590 nfs_mark_client_ready(clp, error);
591 dprintk("<-- nfs_init_client() = xerror %d\n", error);
596 * Create a version 2 or 3 client
598 static int nfs_init_server(struct nfs_server *server,
599 const struct nfs_parsed_mount_data *data)
601 struct nfs_client_initdata cl_init = {
602 .hostname = data->nfs_server.hostname,
603 .addr = (const struct sockaddr *)&data->nfs_server.address,
604 .addrlen = data->nfs_server.addrlen,
605 .rpc_ops = &nfs_v2_clientops,
606 .proto = data->nfs_server.protocol,
608 struct rpc_timeout timeparms;
609 struct nfs_client *clp;
612 dprintk("--> nfs_init_server()\n");
615 if (data->flags & NFS_MOUNT_VER3)
616 cl_init.rpc_ops = &nfs_v3_clientops;
619 /* Allocate or find a client reference we can use */
620 clp = nfs_get_client(&cl_init);
622 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
626 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
627 data->timeo, data->retrans);
628 error = nfs_init_client(clp, &timeparms, data);
632 server->nfs_client = clp;
634 /* Initialise the client representation from the mount data */
635 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
638 server->rsize = nfs_block_size(data->rsize, NULL);
640 server->wsize = nfs_block_size(data->wsize, NULL);
642 server->acregmin = data->acregmin * HZ;
643 server->acregmax = data->acregmax * HZ;
644 server->acdirmin = data->acdirmin * HZ;
645 server->acdirmax = data->acdirmax * HZ;
647 /* Start lockd here, before we might error out */
648 error = nfs_start_lockd(server);
652 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
656 server->namelen = data->namlen;
657 /* Create a client RPC handle for the NFSv3 ACL management interface */
658 nfs_init_server_aclclient(server);
659 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
663 server->nfs_client = NULL;
665 dprintk("<-- nfs_init_server() = xerror %d\n", error);
670 * Load up the server record from information gained in an fsinfo record
672 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
674 unsigned long max_rpc_payload;
676 /* Work out a lot of parameters */
677 if (server->rsize == 0)
678 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
679 if (server->wsize == 0)
680 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
682 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
683 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
684 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
685 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
687 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
688 if (server->rsize > max_rpc_payload)
689 server->rsize = max_rpc_payload;
690 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
691 server->rsize = NFS_MAX_FILE_IO_SIZE;
692 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
694 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
696 if (server->wsize > max_rpc_payload)
697 server->wsize = max_rpc_payload;
698 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
699 server->wsize = NFS_MAX_FILE_IO_SIZE;
700 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
701 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
703 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
704 if (server->dtsize > PAGE_CACHE_SIZE)
705 server->dtsize = PAGE_CACHE_SIZE;
706 if (server->dtsize > server->rsize)
707 server->dtsize = server->rsize;
709 if (server->flags & NFS_MOUNT_NOAC) {
710 server->acregmin = server->acregmax = 0;
711 server->acdirmin = server->acdirmax = 0;
714 server->maxfilesize = fsinfo->maxfilesize;
716 /* We're airborne Set socket buffersize */
717 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
721 * Probe filesystem information, including the FSID on v2/v3
723 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
725 struct nfs_fsinfo fsinfo;
726 struct nfs_client *clp = server->nfs_client;
729 dprintk("--> nfs_probe_fsinfo()\n");
731 if (clp->rpc_ops->set_capabilities != NULL) {
732 error = clp->rpc_ops->set_capabilities(server, mntfh);
737 fsinfo.fattr = fattr;
738 nfs_fattr_init(fattr);
739 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
743 nfs_server_set_fsinfo(server, &fsinfo);
744 error = bdi_init(&server->backing_dev_info);
749 /* Get some general file system info */
750 if (server->namelen == 0) {
751 struct nfs_pathconf pathinfo;
753 pathinfo.fattr = fattr;
754 nfs_fattr_init(fattr);
756 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
757 server->namelen = pathinfo.max_namelen;
760 dprintk("<-- nfs_probe_fsinfo() = 0\n");
764 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
769 * Copy useful information when duplicating a server record
771 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
773 target->flags = source->flags;
774 target->acregmin = source->acregmin;
775 target->acregmax = source->acregmax;
776 target->acdirmin = source->acdirmin;
777 target->acdirmax = source->acdirmax;
778 target->caps = source->caps;
782 * Allocate and initialise a server record
784 static struct nfs_server *nfs_alloc_server(void)
786 struct nfs_server *server;
788 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
792 server->client = server->client_acl = ERR_PTR(-EINVAL);
794 /* Zero out the NFS state stuff */
795 INIT_LIST_HEAD(&server->client_link);
796 INIT_LIST_HEAD(&server->master_link);
798 init_waitqueue_head(&server->active_wq);
799 atomic_set(&server->active, 0);
801 server->io_stats = nfs_alloc_iostats();
802 if (!server->io_stats) {
811 * Free up a server record
813 void nfs_free_server(struct nfs_server *server)
815 dprintk("--> nfs_free_server()\n");
817 spin_lock(&nfs_client_lock);
818 list_del(&server->client_link);
819 list_del(&server->master_link);
820 spin_unlock(&nfs_client_lock);
822 if (server->destroy != NULL)
823 server->destroy(server);
825 if (!IS_ERR(server->client_acl))
826 rpc_shutdown_client(server->client_acl);
827 if (!IS_ERR(server->client))
828 rpc_shutdown_client(server->client);
830 nfs_put_client(server->nfs_client);
832 nfs_free_iostats(server->io_stats);
833 bdi_destroy(&server->backing_dev_info);
835 nfs_release_automount_timer();
836 dprintk("<-- nfs_free_server()\n");
840 * Create a version 2 or 3 volume record
841 * - keyed on server and FSID
843 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
844 struct nfs_fh *mntfh)
846 struct nfs_server *server;
847 struct nfs_fattr fattr;
850 server = nfs_alloc_server();
852 return ERR_PTR(-ENOMEM);
854 /* Get a client representation */
855 error = nfs_init_server(server, data);
859 BUG_ON(!server->nfs_client);
860 BUG_ON(!server->nfs_client->rpc_ops);
861 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
863 /* Probe the root fh to retrieve its FSID */
864 error = nfs_probe_fsinfo(server, mntfh, &fattr);
867 if (server->nfs_client->rpc_ops->version == 3) {
868 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
869 server->namelen = NFS3_MAXNAMLEN;
870 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
871 server->caps |= NFS_CAP_READDIRPLUS;
873 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
874 server->namelen = NFS2_MAXNAMLEN;
877 if (!(fattr.valid & NFS_ATTR_FATTR)) {
878 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
880 dprintk("nfs_create_server: getattr error = %d\n", -error);
884 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
886 dprintk("Server FSID: %llx:%llx\n",
887 (unsigned long long) server->fsid.major,
888 (unsigned long long) server->fsid.minor);
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 spin_lock(&nfs_client_lock);
895 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
896 list_add_tail(&server->master_link, &nfs_volume_list);
897 spin_unlock(&nfs_client_lock);
899 server->mount_time = jiffies;
903 nfs_free_server(server);
904 return ERR_PTR(error);
909 * Initialise an NFS4 client record
911 static int nfs4_init_client(struct nfs_client *clp,
912 const struct rpc_timeout *timeparms,
914 rpc_authflavor_t authflavour)
918 if (clp->cl_cons_state == NFS_CS_READY) {
919 /* the client is initialised already */
920 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
924 /* Check NFS protocol revision and initialize RPC op vector */
925 clp->rpc_ops = &nfs_v4_clientops;
927 error = nfs_create_rpc_client(clp, timeparms, authflavour,
928 RPC_CLNT_CREATE_DISCRTRY);
931 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
933 error = nfs_idmap_new(clp);
935 dprintk("%s: failed to create idmapper. Error = %d\n",
936 __FUNCTION__, error);
939 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
941 nfs_mark_client_ready(clp, NFS_CS_READY);
945 nfs_mark_client_ready(clp, error);
946 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
951 * Set up an NFS4 client
953 static int nfs4_set_client(struct nfs_server *server,
954 const char *hostname,
955 const struct sockaddr *addr,
956 const size_t addrlen,
958 rpc_authflavor_t authflavour,
959 int proto, const struct rpc_timeout *timeparms)
961 struct nfs_client_initdata cl_init = {
962 .hostname = hostname,
965 .rpc_ops = &nfs_v4_clientops,
968 struct nfs_client *clp;
971 dprintk("--> nfs4_set_client()\n");
973 /* Allocate or find a client reference we can use */
974 clp = nfs_get_client(&cl_init);
976 error = PTR_ERR(clp);
979 error = nfs4_init_client(clp, timeparms, ip_addr, authflavour);
983 server->nfs_client = clp;
984 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
990 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
995 * Create a version 4 volume record
997 static int nfs4_init_server(struct nfs_server *server,
998 const struct nfs_parsed_mount_data *data)
1000 struct rpc_timeout timeparms;
1003 dprintk("--> nfs4_init_server()\n");
1005 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1006 data->timeo, data->retrans);
1008 /* Get a client record */
1009 error = nfs4_set_client(server,
1010 data->nfs_server.hostname,
1011 (const struct sockaddr *)&data->nfs_server.address,
1012 data->nfs_server.addrlen,
1013 data->client_address,
1014 data->auth_flavors[0],
1015 data->nfs_server.protocol,
1020 /* Initialise the client representation from the mount data */
1021 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
1022 server->caps |= NFS_CAP_ATOMIC_OPEN;
1025 server->rsize = nfs_block_size(data->rsize, NULL);
1027 server->wsize = nfs_block_size(data->wsize, NULL);
1029 server->acregmin = data->acregmin * HZ;
1030 server->acregmax = data->acregmax * HZ;
1031 server->acdirmin = data->acdirmin * HZ;
1032 server->acdirmax = data->acdirmax * HZ;
1034 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1038 dprintk("<-- nfs4_init_server() = %d\n", error);
1043 * Create a version 4 volume record
1044 * - keyed on server and FSID
1046 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1047 struct nfs_fh *mntfh)
1049 struct nfs_fattr fattr;
1050 struct nfs_server *server;
1053 dprintk("--> nfs4_create_server()\n");
1055 server = nfs_alloc_server();
1057 return ERR_PTR(-ENOMEM);
1059 /* set up the general RPC client */
1060 error = nfs4_init_server(server, data);
1064 BUG_ON(!server->nfs_client);
1065 BUG_ON(!server->nfs_client->rpc_ops);
1066 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1068 /* Probe the root fh to retrieve its FSID */
1069 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1073 dprintk("Server FSID: %llx:%llx\n",
1074 (unsigned long long) server->fsid.major,
1075 (unsigned long long) server->fsid.minor);
1076 dprintk("Mount FH: %d\n", mntfh->size);
1078 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1082 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1083 server->namelen = NFS4_MAXNAMLEN;
1085 BUG_ON(!server->nfs_client);
1086 BUG_ON(!server->nfs_client->rpc_ops);
1087 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1089 spin_lock(&nfs_client_lock);
1090 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1091 list_add_tail(&server->master_link, &nfs_volume_list);
1092 spin_unlock(&nfs_client_lock);
1094 server->mount_time = jiffies;
1095 dprintk("<-- nfs4_create_server() = %p\n", server);
1099 nfs_free_server(server);
1100 dprintk("<-- nfs4_create_server() = error %d\n", error);
1101 return ERR_PTR(error);
1105 * Create an NFS4 referral server record
1107 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1108 struct nfs_fh *mntfh)
1110 struct nfs_client *parent_client;
1111 struct nfs_server *server, *parent_server;
1112 struct nfs_fattr fattr;
1115 dprintk("--> nfs4_create_referral_server()\n");
1117 server = nfs_alloc_server();
1119 return ERR_PTR(-ENOMEM);
1121 parent_server = NFS_SB(data->sb);
1122 parent_client = parent_server->nfs_client;
1124 /* Get a client representation.
1125 * Note: NFSv4 always uses TCP, */
1126 error = nfs4_set_client(server, data->hostname,
1129 parent_client->cl_ipaddr,
1131 parent_server->client->cl_xprt->prot,
1132 parent_server->client->cl_timeout);
1136 /* Initialise the client representation from the parent server */
1137 nfs_server_copy_userdata(server, parent_server);
1138 server->caps |= NFS_CAP_ATOMIC_OPEN;
1140 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1144 BUG_ON(!server->nfs_client);
1145 BUG_ON(!server->nfs_client->rpc_ops);
1146 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1148 /* Probe the root fh to retrieve its FSID and filehandle */
1149 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1153 /* probe the filesystem info for this server filesystem */
1154 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1158 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1159 server->namelen = NFS4_MAXNAMLEN;
1161 dprintk("Referral FSID: %llx:%llx\n",
1162 (unsigned long long) server->fsid.major,
1163 (unsigned long long) server->fsid.minor);
1165 spin_lock(&nfs_client_lock);
1166 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1167 list_add_tail(&server->master_link, &nfs_volume_list);
1168 spin_unlock(&nfs_client_lock);
1170 server->mount_time = jiffies;
1172 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1176 nfs_free_server(server);
1177 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1178 return ERR_PTR(error);
1181 #endif /* CONFIG_NFS_V4 */
1184 * Clone an NFS2, NFS3 or NFS4 server record
1186 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1188 struct nfs_fattr *fattr)
1190 struct nfs_server *server;
1191 struct nfs_fattr fattr_fsinfo;
1194 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1195 (unsigned long long) fattr->fsid.major,
1196 (unsigned long long) fattr->fsid.minor);
1198 server = nfs_alloc_server();
1200 return ERR_PTR(-ENOMEM);
1202 /* Copy data from the source */
1203 server->nfs_client = source->nfs_client;
1204 atomic_inc(&server->nfs_client->cl_count);
1205 nfs_server_copy_userdata(server, source);
1207 server->fsid = fattr->fsid;
1209 error = nfs_init_server_rpcclient(server,
1210 source->client->cl_timeout,
1211 source->client->cl_auth->au_flavor);
1213 goto out_free_server;
1214 if (!IS_ERR(source->client_acl))
1215 nfs_init_server_aclclient(server);
1217 /* probe the filesystem info for this server filesystem */
1218 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1220 goto out_free_server;
1222 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1223 server->namelen = NFS4_MAXNAMLEN;
1225 dprintk("Cloned FSID: %llx:%llx\n",
1226 (unsigned long long) server->fsid.major,
1227 (unsigned long long) server->fsid.minor);
1229 error = nfs_start_lockd(server);
1231 goto out_free_server;
1233 spin_lock(&nfs_client_lock);
1234 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1235 list_add_tail(&server->master_link, &nfs_volume_list);
1236 spin_unlock(&nfs_client_lock);
1238 server->mount_time = jiffies;
1240 dprintk("<-- nfs_clone_server() = %p\n", server);
1244 nfs_free_server(server);
1245 dprintk("<-- nfs_clone_server() = error %d\n", error);
1246 return ERR_PTR(error);
1249 #ifdef CONFIG_PROC_FS
1250 static struct proc_dir_entry *proc_fs_nfs;
1252 static int nfs_server_list_open(struct inode *inode, struct file *file);
1253 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1254 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1255 static void nfs_server_list_stop(struct seq_file *p, void *v);
1256 static int nfs_server_list_show(struct seq_file *m, void *v);
1258 static struct seq_operations nfs_server_list_ops = {
1259 .start = nfs_server_list_start,
1260 .next = nfs_server_list_next,
1261 .stop = nfs_server_list_stop,
1262 .show = nfs_server_list_show,
1265 static const struct file_operations nfs_server_list_fops = {
1266 .open = nfs_server_list_open,
1268 .llseek = seq_lseek,
1269 .release = seq_release,
1272 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1273 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1274 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1275 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1276 static int nfs_volume_list_show(struct seq_file *m, void *v);
1278 static struct seq_operations nfs_volume_list_ops = {
1279 .start = nfs_volume_list_start,
1280 .next = nfs_volume_list_next,
1281 .stop = nfs_volume_list_stop,
1282 .show = nfs_volume_list_show,
1285 static const struct file_operations nfs_volume_list_fops = {
1286 .open = nfs_volume_list_open,
1288 .llseek = seq_lseek,
1289 .release = seq_release,
1293 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1296 static int nfs_server_list_open(struct inode *inode, struct file *file)
1301 ret = seq_open(file, &nfs_server_list_ops);
1305 m = file->private_data;
1306 m->private = PDE(inode)->data;
1312 * set up the iterator to start reading from the server list and return the first item
1314 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1316 /* lock the list against modification */
1317 spin_lock(&nfs_client_lock);
1318 return seq_list_start_head(&nfs_client_list, *_pos);
1322 * move to next server
1324 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1326 return seq_list_next(v, &nfs_client_list, pos);
1330 * clean up after reading from the transports list
1332 static void nfs_server_list_stop(struct seq_file *p, void *v)
1334 spin_unlock(&nfs_client_lock);
1338 * display a header line followed by a load of call lines
1340 static int nfs_server_list_show(struct seq_file *m, void *v)
1342 struct nfs_client *clp;
1344 /* display header on line 1 */
1345 if (v == &nfs_client_list) {
1346 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1350 /* display one transport per line on subsequent lines */
1351 clp = list_entry(v, struct nfs_client, cl_share_link);
1353 seq_printf(m, "v%u %s %s %3d %s\n",
1354 clp->rpc_ops->version,
1355 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1356 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1357 atomic_read(&clp->cl_count),
1364 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1366 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1371 ret = seq_open(file, &nfs_volume_list_ops);
1375 m = file->private_data;
1376 m->private = PDE(inode)->data;
1382 * set up the iterator to start reading from the volume list and return the first item
1384 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1386 /* lock the list against modification */
1387 spin_lock(&nfs_client_lock);
1388 return seq_list_start_head(&nfs_volume_list, *_pos);
1392 * move to next volume
1394 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1396 return seq_list_next(v, &nfs_volume_list, pos);
1400 * clean up after reading from the transports list
1402 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1404 spin_unlock(&nfs_client_lock);
1408 * display a header line followed by a load of call lines
1410 static int nfs_volume_list_show(struct seq_file *m, void *v)
1412 struct nfs_server *server;
1413 struct nfs_client *clp;
1414 char dev[8], fsid[17];
1416 /* display header on line 1 */
1417 if (v == &nfs_volume_list) {
1418 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1421 /* display one transport per line on subsequent lines */
1422 server = list_entry(v, struct nfs_server, master_link);
1423 clp = server->nfs_client;
1425 snprintf(dev, 8, "%u:%u",
1426 MAJOR(server->s_dev), MINOR(server->s_dev));
1428 snprintf(fsid, 17, "%llx:%llx",
1429 (unsigned long long) server->fsid.major,
1430 (unsigned long long) server->fsid.minor);
1432 seq_printf(m, "v%u %s %s %-7s %-17s\n",
1433 clp->rpc_ops->version,
1434 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1435 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1443 * initialise the /proc/fs/nfsfs/ directory
1445 int __init nfs_fs_proc_init(void)
1447 struct proc_dir_entry *p;
1449 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1453 proc_fs_nfs->owner = THIS_MODULE;
1455 /* a file of servers with which we're dealing */
1456 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1460 p->proc_fops = &nfs_server_list_fops;
1461 p->owner = THIS_MODULE;
1463 /* a file of volumes that we have mounted */
1464 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1468 p->proc_fops = &nfs_volume_list_fops;
1469 p->owner = THIS_MODULE;
1473 remove_proc_entry("servers", proc_fs_nfs);
1475 remove_proc_entry("nfsfs", proc_root_fs);
1481 * clean up the /proc/fs/nfsfs/ directory
1483 void nfs_fs_proc_exit(void)
1485 remove_proc_entry("volumes", proc_fs_nfs);
1486 remove_proc_entry("servers", proc_fs_nfs);
1487 remove_proc_entry("nfsfs", proc_root_fs);
1490 #endif /* CONFIG_PROC_FS */