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,
529 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
533 if (nlm_init.nfs_version > 3)
535 if (server->flags & NFS_MOUNT_NONLM)
538 host = nlmclnt_init(&nlm_init);
540 return PTR_ERR(host);
542 server->nlm_host = host;
543 server->destroy = nfs_destroy_server;
548 * Initialise an NFSv3 ACL client connection
550 #ifdef CONFIG_NFS_V3_ACL
551 static void nfs_init_server_aclclient(struct nfs_server *server)
553 if (server->nfs_client->rpc_ops->version != 3)
555 if (server->flags & NFS_MOUNT_NOACL)
558 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
559 if (IS_ERR(server->client_acl))
562 /* No errors! Assume that Sun nfsacls are supported */
563 server->caps |= NFS_CAP_ACLS;
567 server->caps &= ~NFS_CAP_ACLS;
570 static inline void nfs_init_server_aclclient(struct nfs_server *server)
572 server->flags &= ~NFS_MOUNT_NOACL;
573 server->caps &= ~NFS_CAP_ACLS;
578 * Create a general RPC client
580 static int nfs_init_server_rpcclient(struct nfs_server *server,
581 const struct rpc_timeout *timeo,
582 rpc_authflavor_t pseudoflavour)
584 struct nfs_client *clp = server->nfs_client;
586 server->client = rpc_clone_client(clp->cl_rpcclient);
587 if (IS_ERR(server->client)) {
588 dprintk("%s: couldn't create rpc_client!\n", __func__);
589 return PTR_ERR(server->client);
592 memcpy(&server->client->cl_timeout_default,
594 sizeof(server->client->cl_timeout_default));
595 server->client->cl_timeout = &server->client->cl_timeout_default;
597 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
598 struct rpc_auth *auth;
600 auth = rpcauth_create(pseudoflavour, server->client);
602 dprintk("%s: couldn't create credcache!\n", __func__);
603 return PTR_ERR(auth);
606 server->client->cl_softrtry = 0;
607 if (server->flags & NFS_MOUNT_SOFT)
608 server->client->cl_softrtry = 1;
614 * Initialise an NFS2 or NFS3 client
616 static int nfs_init_client(struct nfs_client *clp,
617 const struct rpc_timeout *timeparms,
618 const struct nfs_parsed_mount_data *data)
622 if (clp->cl_cons_state == NFS_CS_READY) {
623 /* the client is already initialised */
624 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
629 * Create a client RPC handle for doing FSSTAT with UNIX auth only
630 * - RFC 2623, sec 2.3.2
632 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX,
633 0, data->flags & NFS_MOUNT_NORESVPORT);
636 nfs_mark_client_ready(clp, NFS_CS_READY);
640 nfs_mark_client_ready(clp, error);
641 dprintk("<-- nfs_init_client() = xerror %d\n", error);
646 * Create a version 2 or 3 client
648 static int nfs_init_server(struct nfs_server *server,
649 const struct nfs_parsed_mount_data *data)
651 struct nfs_client_initdata cl_init = {
652 .hostname = data->nfs_server.hostname,
653 .addr = (const struct sockaddr *)&data->nfs_server.address,
654 .addrlen = data->nfs_server.addrlen,
655 .rpc_ops = &nfs_v2_clientops,
656 .proto = data->nfs_server.protocol,
658 struct rpc_timeout timeparms;
659 struct nfs_client *clp;
662 dprintk("--> nfs_init_server()\n");
665 if (data->flags & NFS_MOUNT_VER3)
666 cl_init.rpc_ops = &nfs_v3_clientops;
669 /* Allocate or find a client reference we can use */
670 clp = nfs_get_client(&cl_init);
672 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
676 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
677 data->timeo, data->retrans);
678 error = nfs_init_client(clp, &timeparms, data);
682 server->nfs_client = clp;
684 /* Initialise the client representation from the mount data */
685 server->flags = data->flags;
688 server->rsize = nfs_block_size(data->rsize, NULL);
690 server->wsize = nfs_block_size(data->wsize, NULL);
692 server->acregmin = data->acregmin * HZ;
693 server->acregmax = data->acregmax * HZ;
694 server->acdirmin = data->acdirmin * HZ;
695 server->acdirmax = data->acdirmax * HZ;
697 /* Start lockd here, before we might error out */
698 error = nfs_start_lockd(server);
702 server->port = data->nfs_server.port;
704 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
708 /* Preserve the values of mount_server-related mount options */
709 if (data->mount_server.addrlen) {
710 memcpy(&server->mountd_address, &data->mount_server.address,
711 data->mount_server.addrlen);
712 server->mountd_addrlen = data->mount_server.addrlen;
714 server->mountd_version = data->mount_server.version;
715 server->mountd_port = data->mount_server.port;
716 server->mountd_protocol = data->mount_server.protocol;
718 server->namelen = data->namlen;
719 /* Create a client RPC handle for the NFSv3 ACL management interface */
720 nfs_init_server_aclclient(server);
721 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
725 server->nfs_client = NULL;
727 dprintk("<-- nfs_init_server() = xerror %d\n", error);
732 * Load up the server record from information gained in an fsinfo record
734 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
736 unsigned long max_rpc_payload;
738 /* Work out a lot of parameters */
739 if (server->rsize == 0)
740 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
741 if (server->wsize == 0)
742 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
744 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
745 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
746 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
747 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
749 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
750 if (server->rsize > max_rpc_payload)
751 server->rsize = max_rpc_payload;
752 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
753 server->rsize = NFS_MAX_FILE_IO_SIZE;
754 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
756 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
758 if (server->wsize > max_rpc_payload)
759 server->wsize = max_rpc_payload;
760 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
761 server->wsize = NFS_MAX_FILE_IO_SIZE;
762 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
763 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
765 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
766 if (server->dtsize > PAGE_CACHE_SIZE)
767 server->dtsize = PAGE_CACHE_SIZE;
768 if (server->dtsize > server->rsize)
769 server->dtsize = server->rsize;
771 if (server->flags & NFS_MOUNT_NOAC) {
772 server->acregmin = server->acregmax = 0;
773 server->acdirmin = server->acdirmax = 0;
776 server->maxfilesize = fsinfo->maxfilesize;
778 /* We're airborne Set socket buffersize */
779 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
783 * Probe filesystem information, including the FSID on v2/v3
785 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
787 struct nfs_fsinfo fsinfo;
788 struct nfs_client *clp = server->nfs_client;
791 dprintk("--> nfs_probe_fsinfo()\n");
793 if (clp->rpc_ops->set_capabilities != NULL) {
794 error = clp->rpc_ops->set_capabilities(server, mntfh);
799 fsinfo.fattr = fattr;
800 nfs_fattr_init(fattr);
801 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
805 nfs_server_set_fsinfo(server, &fsinfo);
806 error = bdi_init(&server->backing_dev_info);
811 /* Get some general file system info */
812 if (server->namelen == 0) {
813 struct nfs_pathconf pathinfo;
815 pathinfo.fattr = fattr;
816 nfs_fattr_init(fattr);
818 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
819 server->namelen = pathinfo.max_namelen;
822 dprintk("<-- nfs_probe_fsinfo() = 0\n");
826 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
831 * Copy useful information when duplicating a server record
833 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
835 target->flags = source->flags;
836 target->acregmin = source->acregmin;
837 target->acregmax = source->acregmax;
838 target->acdirmin = source->acdirmin;
839 target->acdirmax = source->acdirmax;
840 target->caps = source->caps;
844 * Allocate and initialise a server record
846 static struct nfs_server *nfs_alloc_server(void)
848 struct nfs_server *server;
850 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
854 server->client = server->client_acl = ERR_PTR(-EINVAL);
856 /* Zero out the NFS state stuff */
857 INIT_LIST_HEAD(&server->client_link);
858 INIT_LIST_HEAD(&server->master_link);
860 atomic_set(&server->active, 0);
862 server->io_stats = nfs_alloc_iostats();
863 if (!server->io_stats) {
872 * Free up a server record
874 void nfs_free_server(struct nfs_server *server)
876 dprintk("--> nfs_free_server()\n");
878 spin_lock(&nfs_client_lock);
879 list_del(&server->client_link);
880 list_del(&server->master_link);
881 spin_unlock(&nfs_client_lock);
883 if (server->destroy != NULL)
884 server->destroy(server);
886 if (!IS_ERR(server->client_acl))
887 rpc_shutdown_client(server->client_acl);
888 if (!IS_ERR(server->client))
889 rpc_shutdown_client(server->client);
891 nfs_put_client(server->nfs_client);
893 nfs_free_iostats(server->io_stats);
894 bdi_destroy(&server->backing_dev_info);
896 nfs_release_automount_timer();
897 dprintk("<-- nfs_free_server()\n");
901 * Create a version 2 or 3 volume record
902 * - keyed on server and FSID
904 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
905 struct nfs_fh *mntfh)
907 struct nfs_server *server;
908 struct nfs_fattr fattr;
911 server = nfs_alloc_server();
913 return ERR_PTR(-ENOMEM);
915 /* Get a client representation */
916 error = nfs_init_server(server, data);
920 BUG_ON(!server->nfs_client);
921 BUG_ON(!server->nfs_client->rpc_ops);
922 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
924 /* Probe the root fh to retrieve its FSID */
925 error = nfs_probe_fsinfo(server, mntfh, &fattr);
928 if (server->nfs_client->rpc_ops->version == 3) {
929 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
930 server->namelen = NFS3_MAXNAMLEN;
931 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
932 server->caps |= NFS_CAP_READDIRPLUS;
934 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
935 server->namelen = NFS2_MAXNAMLEN;
938 if (!(fattr.valid & NFS_ATTR_FATTR)) {
939 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
941 dprintk("nfs_create_server: getattr error = %d\n", -error);
945 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
947 dprintk("Server FSID: %llx:%llx\n",
948 (unsigned long long) server->fsid.major,
949 (unsigned long long) server->fsid.minor);
951 BUG_ON(!server->nfs_client);
952 BUG_ON(!server->nfs_client->rpc_ops);
953 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
955 spin_lock(&nfs_client_lock);
956 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
957 list_add_tail(&server->master_link, &nfs_volume_list);
958 spin_unlock(&nfs_client_lock);
960 server->mount_time = jiffies;
964 nfs_free_server(server);
965 return ERR_PTR(error);
970 * Initialise an NFS4 client record
972 static int nfs4_init_client(struct nfs_client *clp,
973 const struct rpc_timeout *timeparms,
975 rpc_authflavor_t authflavour,
980 if (clp->cl_cons_state == NFS_CS_READY) {
981 /* the client is initialised already */
982 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
986 /* Check NFS protocol revision and initialize RPC op vector */
987 clp->rpc_ops = &nfs_v4_clientops;
989 error = nfs_create_rpc_client(clp, timeparms, authflavour,
990 1, flags & NFS_MOUNT_NORESVPORT);
993 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
995 error = nfs_idmap_new(clp);
997 dprintk("%s: failed to create idmapper. Error = %d\n",
1001 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
1003 nfs_mark_client_ready(clp, NFS_CS_READY);
1007 nfs_mark_client_ready(clp, error);
1008 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
1013 * Set up an NFS4 client
1015 static int nfs4_set_client(struct nfs_server *server,
1016 const char *hostname,
1017 const struct sockaddr *addr,
1018 const size_t addrlen,
1019 const char *ip_addr,
1020 rpc_authflavor_t authflavour,
1021 int proto, const struct rpc_timeout *timeparms)
1023 struct nfs_client_initdata cl_init = {
1024 .hostname = hostname,
1027 .rpc_ops = &nfs_v4_clientops,
1030 struct nfs_client *clp;
1033 dprintk("--> nfs4_set_client()\n");
1035 /* Allocate or find a client reference we can use */
1036 clp = nfs_get_client(&cl_init);
1038 error = PTR_ERR(clp);
1041 error = nfs4_init_client(clp, timeparms, ip_addr, authflavour,
1046 server->nfs_client = clp;
1047 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
1051 nfs_put_client(clp);
1053 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
1058 * Create a version 4 volume record
1060 static int nfs4_init_server(struct nfs_server *server,
1061 const struct nfs_parsed_mount_data *data)
1063 struct rpc_timeout timeparms;
1066 dprintk("--> nfs4_init_server()\n");
1068 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1069 data->timeo, data->retrans);
1071 /* Initialise the client representation from the mount data */
1072 server->flags = data->flags;
1073 server->caps |= NFS_CAP_ATOMIC_OPEN;
1075 /* Get a client record */
1076 error = nfs4_set_client(server,
1077 data->nfs_server.hostname,
1078 (const struct sockaddr *)&data->nfs_server.address,
1079 data->nfs_server.addrlen,
1080 data->client_address,
1081 data->auth_flavors[0],
1082 data->nfs_server.protocol,
1088 server->rsize = nfs_block_size(data->rsize, NULL);
1090 server->wsize = nfs_block_size(data->wsize, NULL);
1092 server->acregmin = data->acregmin * HZ;
1093 server->acregmax = data->acregmax * HZ;
1094 server->acdirmin = data->acdirmin * HZ;
1095 server->acdirmax = data->acdirmax * HZ;
1097 server->port = data->nfs_server.port;
1099 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1103 dprintk("<-- nfs4_init_server() = %d\n", error);
1108 * Create a version 4 volume record
1109 * - keyed on server and FSID
1111 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1112 struct nfs_fh *mntfh)
1114 struct nfs_fattr fattr;
1115 struct nfs_server *server;
1118 dprintk("--> nfs4_create_server()\n");
1120 server = nfs_alloc_server();
1122 return ERR_PTR(-ENOMEM);
1124 /* set up the general RPC client */
1125 error = nfs4_init_server(server, data);
1129 BUG_ON(!server->nfs_client);
1130 BUG_ON(!server->nfs_client->rpc_ops);
1131 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1133 /* Probe the root fh to retrieve its FSID */
1134 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1138 dprintk("Server FSID: %llx:%llx\n",
1139 (unsigned long long) server->fsid.major,
1140 (unsigned long long) server->fsid.minor);
1141 dprintk("Mount FH: %d\n", mntfh->size);
1143 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1147 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1148 server->namelen = NFS4_MAXNAMLEN;
1150 BUG_ON(!server->nfs_client);
1151 BUG_ON(!server->nfs_client->rpc_ops);
1152 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1154 spin_lock(&nfs_client_lock);
1155 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1156 list_add_tail(&server->master_link, &nfs_volume_list);
1157 spin_unlock(&nfs_client_lock);
1159 server->mount_time = jiffies;
1160 dprintk("<-- nfs4_create_server() = %p\n", server);
1164 nfs_free_server(server);
1165 dprintk("<-- nfs4_create_server() = error %d\n", error);
1166 return ERR_PTR(error);
1170 * Create an NFS4 referral server record
1172 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1173 struct nfs_fh *mntfh)
1175 struct nfs_client *parent_client;
1176 struct nfs_server *server, *parent_server;
1177 struct nfs_fattr fattr;
1180 dprintk("--> nfs4_create_referral_server()\n");
1182 server = nfs_alloc_server();
1184 return ERR_PTR(-ENOMEM);
1186 parent_server = NFS_SB(data->sb);
1187 parent_client = parent_server->nfs_client;
1189 /* Initialise the client representation from the parent server */
1190 nfs_server_copy_userdata(server, parent_server);
1191 server->caps |= NFS_CAP_ATOMIC_OPEN;
1193 /* Get a client representation.
1194 * Note: NFSv4 always uses TCP, */
1195 error = nfs4_set_client(server, data->hostname,
1198 parent_client->cl_ipaddr,
1200 parent_server->client->cl_xprt->prot,
1201 parent_server->client->cl_timeout);
1205 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1209 BUG_ON(!server->nfs_client);
1210 BUG_ON(!server->nfs_client->rpc_ops);
1211 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1213 /* Probe the root fh to retrieve its FSID and filehandle */
1214 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1218 /* probe the filesystem info for this server filesystem */
1219 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1223 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1224 server->namelen = NFS4_MAXNAMLEN;
1226 dprintk("Referral FSID: %llx:%llx\n",
1227 (unsigned long long) server->fsid.major,
1228 (unsigned long long) server->fsid.minor);
1230 spin_lock(&nfs_client_lock);
1231 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1232 list_add_tail(&server->master_link, &nfs_volume_list);
1233 spin_unlock(&nfs_client_lock);
1235 server->mount_time = jiffies;
1237 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1241 nfs_free_server(server);
1242 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1243 return ERR_PTR(error);
1246 #endif /* CONFIG_NFS_V4 */
1249 * Clone an NFS2, NFS3 or NFS4 server record
1251 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1253 struct nfs_fattr *fattr)
1255 struct nfs_server *server;
1256 struct nfs_fattr fattr_fsinfo;
1259 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1260 (unsigned long long) fattr->fsid.major,
1261 (unsigned long long) fattr->fsid.minor);
1263 server = nfs_alloc_server();
1265 return ERR_PTR(-ENOMEM);
1267 /* Copy data from the source */
1268 server->nfs_client = source->nfs_client;
1269 atomic_inc(&server->nfs_client->cl_count);
1270 nfs_server_copy_userdata(server, source);
1272 server->fsid = fattr->fsid;
1274 error = nfs_init_server_rpcclient(server,
1275 source->client->cl_timeout,
1276 source->client->cl_auth->au_flavor);
1278 goto out_free_server;
1279 if (!IS_ERR(source->client_acl))
1280 nfs_init_server_aclclient(server);
1282 /* probe the filesystem info for this server filesystem */
1283 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1285 goto out_free_server;
1287 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1288 server->namelen = NFS4_MAXNAMLEN;
1290 dprintk("Cloned FSID: %llx:%llx\n",
1291 (unsigned long long) server->fsid.major,
1292 (unsigned long long) server->fsid.minor);
1294 error = nfs_start_lockd(server);
1296 goto out_free_server;
1298 spin_lock(&nfs_client_lock);
1299 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1300 list_add_tail(&server->master_link, &nfs_volume_list);
1301 spin_unlock(&nfs_client_lock);
1303 server->mount_time = jiffies;
1305 dprintk("<-- nfs_clone_server() = %p\n", server);
1309 nfs_free_server(server);
1310 dprintk("<-- nfs_clone_server() = error %d\n", error);
1311 return ERR_PTR(error);
1314 #ifdef CONFIG_PROC_FS
1315 static struct proc_dir_entry *proc_fs_nfs;
1317 static int nfs_server_list_open(struct inode *inode, struct file *file);
1318 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1319 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1320 static void nfs_server_list_stop(struct seq_file *p, void *v);
1321 static int nfs_server_list_show(struct seq_file *m, void *v);
1323 static struct seq_operations nfs_server_list_ops = {
1324 .start = nfs_server_list_start,
1325 .next = nfs_server_list_next,
1326 .stop = nfs_server_list_stop,
1327 .show = nfs_server_list_show,
1330 static const struct file_operations nfs_server_list_fops = {
1331 .open = nfs_server_list_open,
1333 .llseek = seq_lseek,
1334 .release = seq_release,
1335 .owner = THIS_MODULE,
1338 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1339 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1340 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1341 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1342 static int nfs_volume_list_show(struct seq_file *m, void *v);
1344 static struct seq_operations nfs_volume_list_ops = {
1345 .start = nfs_volume_list_start,
1346 .next = nfs_volume_list_next,
1347 .stop = nfs_volume_list_stop,
1348 .show = nfs_volume_list_show,
1351 static const struct file_operations nfs_volume_list_fops = {
1352 .open = nfs_volume_list_open,
1354 .llseek = seq_lseek,
1355 .release = seq_release,
1356 .owner = THIS_MODULE,
1360 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1363 static int nfs_server_list_open(struct inode *inode, struct file *file)
1368 ret = seq_open(file, &nfs_server_list_ops);
1372 m = file->private_data;
1373 m->private = PDE(inode)->data;
1379 * set up the iterator to start reading from the server list and return the first item
1381 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1383 /* lock the list against modification */
1384 spin_lock(&nfs_client_lock);
1385 return seq_list_start_head(&nfs_client_list, *_pos);
1389 * move to next server
1391 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1393 return seq_list_next(v, &nfs_client_list, pos);
1397 * clean up after reading from the transports list
1399 static void nfs_server_list_stop(struct seq_file *p, void *v)
1401 spin_unlock(&nfs_client_lock);
1405 * display a header line followed by a load of call lines
1407 static int nfs_server_list_show(struct seq_file *m, void *v)
1409 struct nfs_client *clp;
1411 /* display header on line 1 */
1412 if (v == &nfs_client_list) {
1413 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1417 /* display one transport per line on subsequent lines */
1418 clp = list_entry(v, struct nfs_client, cl_share_link);
1420 seq_printf(m, "v%u %s %s %3d %s\n",
1421 clp->rpc_ops->version,
1422 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1423 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1424 atomic_read(&clp->cl_count),
1431 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1433 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1438 ret = seq_open(file, &nfs_volume_list_ops);
1442 m = file->private_data;
1443 m->private = PDE(inode)->data;
1449 * set up the iterator to start reading from the volume list and return the first item
1451 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1453 /* lock the list against modification */
1454 spin_lock(&nfs_client_lock);
1455 return seq_list_start_head(&nfs_volume_list, *_pos);
1459 * move to next volume
1461 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1463 return seq_list_next(v, &nfs_volume_list, pos);
1467 * clean up after reading from the transports list
1469 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1471 spin_unlock(&nfs_client_lock);
1475 * display a header line followed by a load of call lines
1477 static int nfs_volume_list_show(struct seq_file *m, void *v)
1479 struct nfs_server *server;
1480 struct nfs_client *clp;
1481 char dev[8], fsid[17];
1483 /* display header on line 1 */
1484 if (v == &nfs_volume_list) {
1485 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1488 /* display one transport per line on subsequent lines */
1489 server = list_entry(v, struct nfs_server, master_link);
1490 clp = server->nfs_client;
1492 snprintf(dev, 8, "%u:%u",
1493 MAJOR(server->s_dev), MINOR(server->s_dev));
1495 snprintf(fsid, 17, "%llx:%llx",
1496 (unsigned long long) server->fsid.major,
1497 (unsigned long long) server->fsid.minor);
1499 seq_printf(m, "v%u %s %s %-7s %-17s\n",
1500 clp->rpc_ops->version,
1501 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1502 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1510 * initialise the /proc/fs/nfsfs/ directory
1512 int __init nfs_fs_proc_init(void)
1514 struct proc_dir_entry *p;
1516 proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1520 proc_fs_nfs->owner = THIS_MODULE;
1522 /* a file of servers with which we're dealing */
1523 p = proc_create("servers", S_IFREG|S_IRUGO,
1524 proc_fs_nfs, &nfs_server_list_fops);
1528 /* a file of volumes that we have mounted */
1529 p = proc_create("volumes", S_IFREG|S_IRUGO,
1530 proc_fs_nfs, &nfs_volume_list_fops);
1536 remove_proc_entry("servers", proc_fs_nfs);
1538 remove_proc_entry("fs/nfsfs", NULL);
1544 * clean up the /proc/fs/nfsfs/ directory
1546 void nfs_fs_proc_exit(void)
1548 remove_proc_entry("volumes", proc_fs_nfs);
1549 remove_proc_entry("servers", proc_fs_nfs);
1550 remove_proc_entry("fs/nfsfs", NULL);
1553 #endif /* CONFIG_PROC_FS */