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;
115 struct rpc_cred *cred;
117 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
120 clp->rpc_ops = cl_init->rpc_ops;
122 if (cl_init->rpc_ops->version == 4) {
123 if (nfs_callback_up() < 0)
125 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
128 atomic_set(&clp->cl_count, 1);
129 clp->cl_cons_state = NFS_CS_INITING;
131 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
132 clp->cl_addrlen = cl_init->addrlen;
134 if (cl_init->hostname) {
135 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
136 if (!clp->cl_hostname)
140 INIT_LIST_HEAD(&clp->cl_superblocks);
141 clp->cl_rpcclient = ERR_PTR(-EINVAL);
143 clp->cl_proto = cl_init->proto;
146 init_rwsem(&clp->cl_sem);
147 INIT_LIST_HEAD(&clp->cl_delegations);
148 spin_lock_init(&clp->cl_lock);
149 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
150 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
151 clp->cl_boot_time = CURRENT_TIME;
152 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
154 cred = rpc_lookup_machine_cred();
156 clp->cl_machine_cred = cred;
161 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
169 static void nfs4_shutdown_client(struct nfs_client *clp)
172 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
173 nfs4_kill_renewd(clp);
174 BUG_ON(!RB_EMPTY_ROOT(&clp->cl_state_owners));
175 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
176 nfs_idmap_delete(clp);
178 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
183 * Destroy a shared client record
185 static void nfs_free_client(struct nfs_client *clp)
187 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
189 nfs4_shutdown_client(clp);
191 /* -EIO all pending I/O */
192 if (!IS_ERR(clp->cl_rpcclient))
193 rpc_shutdown_client(clp->cl_rpcclient);
195 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
198 if (clp->cl_machine_cred != NULL)
199 put_rpccred(clp->cl_machine_cred);
201 kfree(clp->cl_hostname);
204 dprintk("<-- nfs_free_client()\n");
208 * Release a reference to a shared client record
210 void nfs_put_client(struct nfs_client *clp)
215 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
217 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
218 list_del(&clp->cl_share_link);
219 spin_unlock(&nfs_client_lock);
221 BUG_ON(!list_empty(&clp->cl_superblocks));
223 nfs_free_client(clp);
227 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr_in *sa1,
228 const struct sockaddr_in *sa2)
230 return sa1->sin_addr.s_addr == sa2->sin_addr.s_addr;
233 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr_in6 *sa1,
234 const struct sockaddr_in6 *sa2)
236 return ipv6_addr_equal(&sa1->sin6_addr, &sa2->sin6_addr);
239 static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
240 const struct sockaddr *sa2)
242 switch (sa1->sa_family) {
244 return nfs_sockaddr_match_ipaddr4((const struct sockaddr_in *)sa1,
245 (const struct sockaddr_in *)sa2);
247 return nfs_sockaddr_match_ipaddr6((const struct sockaddr_in6 *)sa1,
248 (const struct sockaddr_in6 *)sa2);
254 * Find a client by IP address and protocol version
255 * - returns NULL if no such client
257 struct nfs_client *nfs_find_client(const struct sockaddr *addr, u32 nfsversion)
259 struct nfs_client *clp;
261 spin_lock(&nfs_client_lock);
262 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
263 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
265 /* Don't match clients that failed to initialise properly */
266 if (clp->cl_cons_state != NFS_CS_READY)
269 /* Different NFS versions cannot share the same nfs_client */
270 if (clp->rpc_ops->version != nfsversion)
273 if (addr->sa_family != clap->sa_family)
275 /* Match only the IP address, not the port number */
276 if (!nfs_sockaddr_match_ipaddr(addr, clap))
279 atomic_inc(&clp->cl_count);
280 spin_unlock(&nfs_client_lock);
283 spin_unlock(&nfs_client_lock);
288 * Find a client by IP address and protocol version
289 * - returns NULL if no such client
291 struct nfs_client *nfs_find_client_next(struct nfs_client *clp)
293 struct sockaddr *sap = (struct sockaddr *)&clp->cl_addr;
294 u32 nfsvers = clp->rpc_ops->version;
296 spin_lock(&nfs_client_lock);
297 list_for_each_entry_continue(clp, &nfs_client_list, cl_share_link) {
298 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
300 /* Don't match clients that failed to initialise properly */
301 if (clp->cl_cons_state != NFS_CS_READY)
304 /* Different NFS versions cannot share the same nfs_client */
305 if (clp->rpc_ops->version != nfsvers)
308 if (sap->sa_family != clap->sa_family)
310 /* Match only the IP address, not the port number */
311 if (!nfs_sockaddr_match_ipaddr(sap, clap))
314 atomic_inc(&clp->cl_count);
315 spin_unlock(&nfs_client_lock);
318 spin_unlock(&nfs_client_lock);
323 * Find an nfs_client on the list that matches the initialisation data
326 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
328 struct nfs_client *clp;
330 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
331 /* Don't match clients that failed to initialise properly */
332 if (clp->cl_cons_state < 0)
335 /* Different NFS versions cannot share the same nfs_client */
336 if (clp->rpc_ops != data->rpc_ops)
339 if (clp->cl_proto != data->proto)
342 /* Match the full socket address */
343 if (memcmp(&clp->cl_addr, data->addr, sizeof(clp->cl_addr)) != 0)
346 atomic_inc(&clp->cl_count);
353 * Look up a client by IP address and protocol version
354 * - creates a new record if one doesn't yet exist
356 static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
358 struct nfs_client *clp, *new = NULL;
361 dprintk("--> nfs_get_client(%s,v%u)\n",
362 cl_init->hostname ?: "", cl_init->rpc_ops->version);
364 /* see if the client already exists */
366 spin_lock(&nfs_client_lock);
368 clp = nfs_match_client(cl_init);
374 spin_unlock(&nfs_client_lock);
376 new = nfs_alloc_client(cl_init);
379 return ERR_PTR(-ENOMEM);
381 /* install a new client and return with it unready */
384 list_add(&clp->cl_share_link, &nfs_client_list);
385 spin_unlock(&nfs_client_lock);
386 dprintk("--> nfs_get_client() = %p [new]\n", clp);
389 /* found an existing client
390 * - make sure it's ready before returning
393 spin_unlock(&nfs_client_lock);
396 nfs_free_client(new);
398 error = wait_event_killable(nfs_client_active_wq,
399 clp->cl_cons_state != NFS_CS_INITING);
402 return ERR_PTR(-ERESTARTSYS);
405 if (clp->cl_cons_state < NFS_CS_READY) {
406 error = clp->cl_cons_state;
408 return ERR_PTR(error);
411 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
413 dprintk("--> nfs_get_client() = %p [share]\n", clp);
418 * Mark a server as ready or failed
420 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
422 clp->cl_cons_state = state;
423 wake_up_all(&nfs_client_active_wq);
427 * Initialise the timeout values for a connection
429 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
430 unsigned int timeo, unsigned int retrans)
432 to->to_initval = timeo * HZ / 10;
433 to->to_retries = retrans;
436 case XPRT_TRANSPORT_TCP:
437 case XPRT_TRANSPORT_RDMA:
438 if (to->to_retries == 0)
439 to->to_retries = NFS_DEF_TCP_RETRANS;
440 if (to->to_initval == 0)
441 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
442 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
443 to->to_initval = NFS_MAX_TCP_TIMEOUT;
444 to->to_increment = to->to_initval;
445 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
446 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
447 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
448 if (to->to_maxval < to->to_initval)
449 to->to_maxval = to->to_initval;
450 to->to_exponential = 0;
452 case XPRT_TRANSPORT_UDP:
453 if (to->to_retries == 0)
454 to->to_retries = NFS_DEF_UDP_RETRANS;
456 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
457 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
458 to->to_initval = NFS_MAX_UDP_TIMEOUT;
459 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
460 to->to_exponential = 1;
468 * Create an RPC client handle
470 static int nfs_create_rpc_client(struct nfs_client *clp,
471 const struct rpc_timeout *timeparms,
472 rpc_authflavor_t flavor,
473 int discrtry, int noresvport)
475 struct rpc_clnt *clnt = NULL;
476 struct rpc_create_args args = {
477 .protocol = clp->cl_proto,
478 .address = (struct sockaddr *)&clp->cl_addr,
479 .addrsize = clp->cl_addrlen,
480 .timeout = timeparms,
481 .servername = clp->cl_hostname,
482 .program = &nfs_program,
483 .version = clp->rpc_ops->version,
484 .authflavor = flavor,
488 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
490 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
492 if (!IS_ERR(clp->cl_rpcclient))
495 clnt = rpc_create(&args);
497 dprintk("%s: cannot create RPC client. Error = %ld\n",
498 __func__, PTR_ERR(clnt));
499 return PTR_ERR(clnt);
502 clp->cl_rpcclient = clnt;
507 * Version 2 or 3 client destruction
509 static void nfs_destroy_server(struct nfs_server *server)
511 if (!(server->flags & NFS_MOUNT_NONLM))
512 nlmclnt_done(server->nlm_host);
516 * Version 2 or 3 lockd setup
518 static int nfs_start_lockd(struct nfs_server *server)
520 struct nlm_host *host;
521 struct nfs_client *clp = server->nfs_client;
522 struct nlmclnt_initdata nlm_init = {
523 .hostname = clp->cl_hostname,
524 .address = (struct sockaddr *)&clp->cl_addr,
525 .addrlen = clp->cl_addrlen,
526 .protocol = server->flags & NFS_MOUNT_TCP ?
527 IPPROTO_TCP : IPPROTO_UDP,
528 .nfs_version = clp->rpc_ops->version,
531 if (nlm_init.nfs_version > 3)
533 if (server->flags & NFS_MOUNT_NONLM)
536 host = nlmclnt_init(&nlm_init);
538 return PTR_ERR(host);
540 server->nlm_host = host;
541 server->destroy = nfs_destroy_server;
546 * Initialise an NFSv3 ACL client connection
548 #ifdef CONFIG_NFS_V3_ACL
549 static void nfs_init_server_aclclient(struct nfs_server *server)
551 if (server->nfs_client->rpc_ops->version != 3)
553 if (server->flags & NFS_MOUNT_NOACL)
556 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
557 if (IS_ERR(server->client_acl))
560 /* No errors! Assume that Sun nfsacls are supported */
561 server->caps |= NFS_CAP_ACLS;
565 server->caps &= ~NFS_CAP_ACLS;
568 static inline void nfs_init_server_aclclient(struct nfs_server *server)
570 server->flags &= ~NFS_MOUNT_NOACL;
571 server->caps &= ~NFS_CAP_ACLS;
576 * Create a general RPC client
578 static int nfs_init_server_rpcclient(struct nfs_server *server,
579 const struct rpc_timeout *timeo,
580 rpc_authflavor_t pseudoflavour)
582 struct nfs_client *clp = server->nfs_client;
584 server->client = rpc_clone_client(clp->cl_rpcclient);
585 if (IS_ERR(server->client)) {
586 dprintk("%s: couldn't create rpc_client!\n", __func__);
587 return PTR_ERR(server->client);
590 memcpy(&server->client->cl_timeout_default,
592 sizeof(server->client->cl_timeout_default));
593 server->client->cl_timeout = &server->client->cl_timeout_default;
595 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
596 struct rpc_auth *auth;
598 auth = rpcauth_create(pseudoflavour, server->client);
600 dprintk("%s: couldn't create credcache!\n", __func__);
601 return PTR_ERR(auth);
604 server->client->cl_softrtry = 0;
605 if (server->flags & NFS_MOUNT_SOFT)
606 server->client->cl_softrtry = 1;
612 * Initialise an NFS2 or NFS3 client
614 static int nfs_init_client(struct nfs_client *clp,
615 const struct rpc_timeout *timeparms,
616 const struct nfs_parsed_mount_data *data)
620 if (clp->cl_cons_state == NFS_CS_READY) {
621 /* the client is already initialised */
622 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
627 * Create a client RPC handle for doing FSSTAT with UNIX auth only
628 * - RFC 2623, sec 2.3.2
630 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX,
631 0, data->flags & NFS_MOUNT_NORESVPORT);
634 nfs_mark_client_ready(clp, NFS_CS_READY);
638 nfs_mark_client_ready(clp, error);
639 dprintk("<-- nfs_init_client() = xerror %d\n", error);
644 * Create a version 2 or 3 client
646 static int nfs_init_server(struct nfs_server *server,
647 const struct nfs_parsed_mount_data *data)
649 struct nfs_client_initdata cl_init = {
650 .hostname = data->nfs_server.hostname,
651 .addr = (const struct sockaddr *)&data->nfs_server.address,
652 .addrlen = data->nfs_server.addrlen,
653 .rpc_ops = &nfs_v2_clientops,
654 .proto = data->nfs_server.protocol,
656 struct rpc_timeout timeparms;
657 struct nfs_client *clp;
660 dprintk("--> nfs_init_server()\n");
663 if (data->flags & NFS_MOUNT_VER3)
664 cl_init.rpc_ops = &nfs_v3_clientops;
667 /* Allocate or find a client reference we can use */
668 clp = nfs_get_client(&cl_init);
670 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
674 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
675 data->timeo, data->retrans);
676 error = nfs_init_client(clp, &timeparms, data);
680 server->nfs_client = clp;
682 /* Initialise the client representation from the mount data */
683 server->flags = data->flags;
686 server->rsize = nfs_block_size(data->rsize, NULL);
688 server->wsize = nfs_block_size(data->wsize, NULL);
690 server->acregmin = data->acregmin * HZ;
691 server->acregmax = data->acregmax * HZ;
692 server->acdirmin = data->acdirmin * HZ;
693 server->acdirmax = data->acdirmax * HZ;
695 /* Start lockd here, before we might error out */
696 error = nfs_start_lockd(server);
700 server->port = data->nfs_server.port;
702 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
706 /* Preserve the values of mount_server-related mount options */
707 if (data->mount_server.addrlen) {
708 memcpy(&server->mountd_address, &data->mount_server.address,
709 data->mount_server.addrlen);
710 server->mountd_addrlen = data->mount_server.addrlen;
712 server->mountd_version = data->mount_server.version;
713 server->mountd_port = data->mount_server.port;
714 server->mountd_protocol = data->mount_server.protocol;
716 server->namelen = data->namlen;
717 /* Create a client RPC handle for the NFSv3 ACL management interface */
718 nfs_init_server_aclclient(server);
719 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
723 server->nfs_client = NULL;
725 dprintk("<-- nfs_init_server() = xerror %d\n", error);
730 * Load up the server record from information gained in an fsinfo record
732 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
734 unsigned long max_rpc_payload;
736 /* Work out a lot of parameters */
737 if (server->rsize == 0)
738 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
739 if (server->wsize == 0)
740 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
742 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
743 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
744 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
745 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
747 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
748 if (server->rsize > max_rpc_payload)
749 server->rsize = max_rpc_payload;
750 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
751 server->rsize = NFS_MAX_FILE_IO_SIZE;
752 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
754 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
756 if (server->wsize > max_rpc_payload)
757 server->wsize = max_rpc_payload;
758 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
759 server->wsize = NFS_MAX_FILE_IO_SIZE;
760 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
761 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
763 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
764 if (server->dtsize > PAGE_CACHE_SIZE)
765 server->dtsize = PAGE_CACHE_SIZE;
766 if (server->dtsize > server->rsize)
767 server->dtsize = server->rsize;
769 if (server->flags & NFS_MOUNT_NOAC) {
770 server->acregmin = server->acregmax = 0;
771 server->acdirmin = server->acdirmax = 0;
774 server->maxfilesize = fsinfo->maxfilesize;
776 /* We're airborne Set socket buffersize */
777 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
781 * Probe filesystem information, including the FSID on v2/v3
783 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
785 struct nfs_fsinfo fsinfo;
786 struct nfs_client *clp = server->nfs_client;
789 dprintk("--> nfs_probe_fsinfo()\n");
791 if (clp->rpc_ops->set_capabilities != NULL) {
792 error = clp->rpc_ops->set_capabilities(server, mntfh);
797 fsinfo.fattr = fattr;
798 nfs_fattr_init(fattr);
799 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
803 nfs_server_set_fsinfo(server, &fsinfo);
804 error = bdi_init(&server->backing_dev_info);
809 /* Get some general file system info */
810 if (server->namelen == 0) {
811 struct nfs_pathconf pathinfo;
813 pathinfo.fattr = fattr;
814 nfs_fattr_init(fattr);
816 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
817 server->namelen = pathinfo.max_namelen;
820 dprintk("<-- nfs_probe_fsinfo() = 0\n");
824 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
829 * Copy useful information when duplicating a server record
831 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
833 target->flags = source->flags;
834 target->acregmin = source->acregmin;
835 target->acregmax = source->acregmax;
836 target->acdirmin = source->acdirmin;
837 target->acdirmax = source->acdirmax;
838 target->caps = source->caps;
842 * Allocate and initialise a server record
844 static struct nfs_server *nfs_alloc_server(void)
846 struct nfs_server *server;
848 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
852 server->client = server->client_acl = ERR_PTR(-EINVAL);
854 /* Zero out the NFS state stuff */
855 INIT_LIST_HEAD(&server->client_link);
856 INIT_LIST_HEAD(&server->master_link);
858 atomic_set(&server->active, 0);
860 server->io_stats = nfs_alloc_iostats();
861 if (!server->io_stats) {
870 * Free up a server record
872 void nfs_free_server(struct nfs_server *server)
874 dprintk("--> nfs_free_server()\n");
876 spin_lock(&nfs_client_lock);
877 list_del(&server->client_link);
878 list_del(&server->master_link);
879 spin_unlock(&nfs_client_lock);
881 if (server->destroy != NULL)
882 server->destroy(server);
884 if (!IS_ERR(server->client_acl))
885 rpc_shutdown_client(server->client_acl);
886 if (!IS_ERR(server->client))
887 rpc_shutdown_client(server->client);
889 nfs_put_client(server->nfs_client);
891 nfs_free_iostats(server->io_stats);
892 bdi_destroy(&server->backing_dev_info);
894 nfs_release_automount_timer();
895 dprintk("<-- nfs_free_server()\n");
899 * Create a version 2 or 3 volume record
900 * - keyed on server and FSID
902 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
903 struct nfs_fh *mntfh)
905 struct nfs_server *server;
906 struct nfs_fattr fattr;
909 server = nfs_alloc_server();
911 return ERR_PTR(-ENOMEM);
913 /* Get a client representation */
914 error = nfs_init_server(server, data);
918 BUG_ON(!server->nfs_client);
919 BUG_ON(!server->nfs_client->rpc_ops);
920 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
922 /* Probe the root fh to retrieve its FSID */
923 error = nfs_probe_fsinfo(server, mntfh, &fattr);
926 if (server->nfs_client->rpc_ops->version == 3) {
927 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
928 server->namelen = NFS3_MAXNAMLEN;
929 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
930 server->caps |= NFS_CAP_READDIRPLUS;
932 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
933 server->namelen = NFS2_MAXNAMLEN;
936 if (!(fattr.valid & NFS_ATTR_FATTR)) {
937 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
939 dprintk("nfs_create_server: getattr error = %d\n", -error);
943 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
945 dprintk("Server FSID: %llx:%llx\n",
946 (unsigned long long) server->fsid.major,
947 (unsigned long long) server->fsid.minor);
949 BUG_ON(!server->nfs_client);
950 BUG_ON(!server->nfs_client->rpc_ops);
951 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
953 spin_lock(&nfs_client_lock);
954 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
955 list_add_tail(&server->master_link, &nfs_volume_list);
956 spin_unlock(&nfs_client_lock);
958 server->mount_time = jiffies;
962 nfs_free_server(server);
963 return ERR_PTR(error);
968 * Initialise an NFS4 client record
970 static int nfs4_init_client(struct nfs_client *clp,
971 const struct rpc_timeout *timeparms,
973 rpc_authflavor_t authflavour,
978 if (clp->cl_cons_state == NFS_CS_READY) {
979 /* the client is initialised already */
980 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
984 /* Check NFS protocol revision and initialize RPC op vector */
985 clp->rpc_ops = &nfs_v4_clientops;
987 error = nfs_create_rpc_client(clp, timeparms, authflavour,
988 1, flags & NFS_MOUNT_NORESVPORT);
991 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
993 error = nfs_idmap_new(clp);
995 dprintk("%s: failed to create idmapper. Error = %d\n",
999 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
1001 nfs_mark_client_ready(clp, NFS_CS_READY);
1005 nfs_mark_client_ready(clp, error);
1006 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
1011 * Set up an NFS4 client
1013 static int nfs4_set_client(struct nfs_server *server,
1014 const char *hostname,
1015 const struct sockaddr *addr,
1016 const size_t addrlen,
1017 const char *ip_addr,
1018 rpc_authflavor_t authflavour,
1019 int proto, const struct rpc_timeout *timeparms)
1021 struct nfs_client_initdata cl_init = {
1022 .hostname = hostname,
1025 .rpc_ops = &nfs_v4_clientops,
1028 struct nfs_client *clp;
1031 dprintk("--> nfs4_set_client()\n");
1033 /* Allocate or find a client reference we can use */
1034 clp = nfs_get_client(&cl_init);
1036 error = PTR_ERR(clp);
1039 error = nfs4_init_client(clp, timeparms, ip_addr, authflavour,
1044 server->nfs_client = clp;
1045 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
1049 nfs_put_client(clp);
1051 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
1056 * Create a version 4 volume record
1058 static int nfs4_init_server(struct nfs_server *server,
1059 const struct nfs_parsed_mount_data *data)
1061 struct rpc_timeout timeparms;
1064 dprintk("--> nfs4_init_server()\n");
1066 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1067 data->timeo, data->retrans);
1069 /* Initialise the client representation from the mount data */
1070 server->flags = data->flags;
1071 server->caps |= NFS_CAP_ATOMIC_OPEN;
1073 /* Get a client record */
1074 error = nfs4_set_client(server,
1075 data->nfs_server.hostname,
1076 (const struct sockaddr *)&data->nfs_server.address,
1077 data->nfs_server.addrlen,
1078 data->client_address,
1079 data->auth_flavors[0],
1080 data->nfs_server.protocol,
1086 server->rsize = nfs_block_size(data->rsize, NULL);
1088 server->wsize = nfs_block_size(data->wsize, NULL);
1090 server->acregmin = data->acregmin * HZ;
1091 server->acregmax = data->acregmax * HZ;
1092 server->acdirmin = data->acdirmin * HZ;
1093 server->acdirmax = data->acdirmax * HZ;
1095 server->port = data->nfs_server.port;
1097 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1101 dprintk("<-- nfs4_init_server() = %d\n", error);
1106 * Create a version 4 volume record
1107 * - keyed on server and FSID
1109 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1110 struct nfs_fh *mntfh)
1112 struct nfs_fattr fattr;
1113 struct nfs_server *server;
1116 dprintk("--> nfs4_create_server()\n");
1118 server = nfs_alloc_server();
1120 return ERR_PTR(-ENOMEM);
1122 /* set up the general RPC client */
1123 error = nfs4_init_server(server, data);
1127 BUG_ON(!server->nfs_client);
1128 BUG_ON(!server->nfs_client->rpc_ops);
1129 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1131 /* Probe the root fh to retrieve its FSID */
1132 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1136 dprintk("Server FSID: %llx:%llx\n",
1137 (unsigned long long) server->fsid.major,
1138 (unsigned long long) server->fsid.minor);
1139 dprintk("Mount FH: %d\n", mntfh->size);
1141 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1145 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1146 server->namelen = NFS4_MAXNAMLEN;
1148 BUG_ON(!server->nfs_client);
1149 BUG_ON(!server->nfs_client->rpc_ops);
1150 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1152 spin_lock(&nfs_client_lock);
1153 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1154 list_add_tail(&server->master_link, &nfs_volume_list);
1155 spin_unlock(&nfs_client_lock);
1157 server->mount_time = jiffies;
1158 dprintk("<-- nfs4_create_server() = %p\n", server);
1162 nfs_free_server(server);
1163 dprintk("<-- nfs4_create_server() = error %d\n", error);
1164 return ERR_PTR(error);
1168 * Create an NFS4 referral server record
1170 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1171 struct nfs_fh *mntfh)
1173 struct nfs_client *parent_client;
1174 struct nfs_server *server, *parent_server;
1175 struct nfs_fattr fattr;
1178 dprintk("--> nfs4_create_referral_server()\n");
1180 server = nfs_alloc_server();
1182 return ERR_PTR(-ENOMEM);
1184 parent_server = NFS_SB(data->sb);
1185 parent_client = parent_server->nfs_client;
1187 /* Initialise the client representation from the parent server */
1188 nfs_server_copy_userdata(server, parent_server);
1189 server->caps |= NFS_CAP_ATOMIC_OPEN;
1191 /* Get a client representation.
1192 * Note: NFSv4 always uses TCP, */
1193 error = nfs4_set_client(server, data->hostname,
1196 parent_client->cl_ipaddr,
1198 parent_server->client->cl_xprt->prot,
1199 parent_server->client->cl_timeout);
1203 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1207 BUG_ON(!server->nfs_client);
1208 BUG_ON(!server->nfs_client->rpc_ops);
1209 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1211 /* Probe the root fh to retrieve its FSID and filehandle */
1212 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1216 /* probe the filesystem info for this server filesystem */
1217 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1221 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1222 server->namelen = NFS4_MAXNAMLEN;
1224 dprintk("Referral FSID: %llx:%llx\n",
1225 (unsigned long long) server->fsid.major,
1226 (unsigned long long) server->fsid.minor);
1228 spin_lock(&nfs_client_lock);
1229 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1230 list_add_tail(&server->master_link, &nfs_volume_list);
1231 spin_unlock(&nfs_client_lock);
1233 server->mount_time = jiffies;
1235 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1239 nfs_free_server(server);
1240 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1241 return ERR_PTR(error);
1244 #endif /* CONFIG_NFS_V4 */
1247 * Clone an NFS2, NFS3 or NFS4 server record
1249 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1251 struct nfs_fattr *fattr)
1253 struct nfs_server *server;
1254 struct nfs_fattr fattr_fsinfo;
1257 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1258 (unsigned long long) fattr->fsid.major,
1259 (unsigned long long) fattr->fsid.minor);
1261 server = nfs_alloc_server();
1263 return ERR_PTR(-ENOMEM);
1265 /* Copy data from the source */
1266 server->nfs_client = source->nfs_client;
1267 atomic_inc(&server->nfs_client->cl_count);
1268 nfs_server_copy_userdata(server, source);
1270 server->fsid = fattr->fsid;
1272 error = nfs_init_server_rpcclient(server,
1273 source->client->cl_timeout,
1274 source->client->cl_auth->au_flavor);
1276 goto out_free_server;
1277 if (!IS_ERR(source->client_acl))
1278 nfs_init_server_aclclient(server);
1280 /* probe the filesystem info for this server filesystem */
1281 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1283 goto out_free_server;
1285 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1286 server->namelen = NFS4_MAXNAMLEN;
1288 dprintk("Cloned FSID: %llx:%llx\n",
1289 (unsigned long long) server->fsid.major,
1290 (unsigned long long) server->fsid.minor);
1292 error = nfs_start_lockd(server);
1294 goto out_free_server;
1296 spin_lock(&nfs_client_lock);
1297 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1298 list_add_tail(&server->master_link, &nfs_volume_list);
1299 spin_unlock(&nfs_client_lock);
1301 server->mount_time = jiffies;
1303 dprintk("<-- nfs_clone_server() = %p\n", server);
1307 nfs_free_server(server);
1308 dprintk("<-- nfs_clone_server() = error %d\n", error);
1309 return ERR_PTR(error);
1312 #ifdef CONFIG_PROC_FS
1313 static struct proc_dir_entry *proc_fs_nfs;
1315 static int nfs_server_list_open(struct inode *inode, struct file *file);
1316 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1317 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1318 static void nfs_server_list_stop(struct seq_file *p, void *v);
1319 static int nfs_server_list_show(struct seq_file *m, void *v);
1321 static struct seq_operations nfs_server_list_ops = {
1322 .start = nfs_server_list_start,
1323 .next = nfs_server_list_next,
1324 .stop = nfs_server_list_stop,
1325 .show = nfs_server_list_show,
1328 static const struct file_operations nfs_server_list_fops = {
1329 .open = nfs_server_list_open,
1331 .llseek = seq_lseek,
1332 .release = seq_release,
1333 .owner = THIS_MODULE,
1336 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1337 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1338 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1339 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1340 static int nfs_volume_list_show(struct seq_file *m, void *v);
1342 static struct seq_operations nfs_volume_list_ops = {
1343 .start = nfs_volume_list_start,
1344 .next = nfs_volume_list_next,
1345 .stop = nfs_volume_list_stop,
1346 .show = nfs_volume_list_show,
1349 static const struct file_operations nfs_volume_list_fops = {
1350 .open = nfs_volume_list_open,
1352 .llseek = seq_lseek,
1353 .release = seq_release,
1354 .owner = THIS_MODULE,
1358 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1361 static int nfs_server_list_open(struct inode *inode, struct file *file)
1366 ret = seq_open(file, &nfs_server_list_ops);
1370 m = file->private_data;
1371 m->private = PDE(inode)->data;
1377 * set up the iterator to start reading from the server list and return the first item
1379 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1381 /* lock the list against modification */
1382 spin_lock(&nfs_client_lock);
1383 return seq_list_start_head(&nfs_client_list, *_pos);
1387 * move to next server
1389 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1391 return seq_list_next(v, &nfs_client_list, pos);
1395 * clean up after reading from the transports list
1397 static void nfs_server_list_stop(struct seq_file *p, void *v)
1399 spin_unlock(&nfs_client_lock);
1403 * display a header line followed by a load of call lines
1405 static int nfs_server_list_show(struct seq_file *m, void *v)
1407 struct nfs_client *clp;
1409 /* display header on line 1 */
1410 if (v == &nfs_client_list) {
1411 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1415 /* display one transport per line on subsequent lines */
1416 clp = list_entry(v, struct nfs_client, cl_share_link);
1418 seq_printf(m, "v%u %s %s %3d %s\n",
1419 clp->rpc_ops->version,
1420 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1421 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1422 atomic_read(&clp->cl_count),
1429 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1431 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1436 ret = seq_open(file, &nfs_volume_list_ops);
1440 m = file->private_data;
1441 m->private = PDE(inode)->data;
1447 * set up the iterator to start reading from the volume list and return the first item
1449 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1451 /* lock the list against modification */
1452 spin_lock(&nfs_client_lock);
1453 return seq_list_start_head(&nfs_volume_list, *_pos);
1457 * move to next volume
1459 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1461 return seq_list_next(v, &nfs_volume_list, pos);
1465 * clean up after reading from the transports list
1467 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1469 spin_unlock(&nfs_client_lock);
1473 * display a header line followed by a load of call lines
1475 static int nfs_volume_list_show(struct seq_file *m, void *v)
1477 struct nfs_server *server;
1478 struct nfs_client *clp;
1479 char dev[8], fsid[17];
1481 /* display header on line 1 */
1482 if (v == &nfs_volume_list) {
1483 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1486 /* display one transport per line on subsequent lines */
1487 server = list_entry(v, struct nfs_server, master_link);
1488 clp = server->nfs_client;
1490 snprintf(dev, 8, "%u:%u",
1491 MAJOR(server->s_dev), MINOR(server->s_dev));
1493 snprintf(fsid, 17, "%llx:%llx",
1494 (unsigned long long) server->fsid.major,
1495 (unsigned long long) server->fsid.minor);
1497 seq_printf(m, "v%u %s %s %-7s %-17s\n",
1498 clp->rpc_ops->version,
1499 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1500 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1508 * initialise the /proc/fs/nfsfs/ directory
1510 int __init nfs_fs_proc_init(void)
1512 struct proc_dir_entry *p;
1514 proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1518 proc_fs_nfs->owner = THIS_MODULE;
1520 /* a file of servers with which we're dealing */
1521 p = proc_create("servers", S_IFREG|S_IRUGO,
1522 proc_fs_nfs, &nfs_server_list_fops);
1526 /* a file of volumes that we have mounted */
1527 p = proc_create("volumes", S_IFREG|S_IRUGO,
1528 proc_fs_nfs, &nfs_volume_list_fops);
1534 remove_proc_entry("servers", proc_fs_nfs);
1536 remove_proc_entry("fs/nfsfs", NULL);
1542 * clean up the /proc/fs/nfsfs/ directory
1544 void nfs_fs_proc_exit(void)
1546 remove_proc_entry("volumes", proc_fs_nfs);
1547 remove_proc_entry("servers", proc_fs_nfs);
1548 remove_proc_entry("fs/nfsfs", NULL);
1551 #endif /* CONFIG_PROC_FS */