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_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;
153 cred = rpc_lookup_machine_cred();
155 clp->cl_machine_cred = cred;
160 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
168 static void nfs4_shutdown_client(struct nfs_client *clp)
171 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
172 nfs4_kill_renewd(clp);
173 BUG_ON(!RB_EMPTY_ROOT(&clp->cl_state_owners));
174 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
175 nfs_idmap_delete(clp);
177 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
182 * Destroy a shared client record
184 static void nfs_free_client(struct nfs_client *clp)
186 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
188 nfs4_shutdown_client(clp);
190 /* -EIO all pending I/O */
191 if (!IS_ERR(clp->cl_rpcclient))
192 rpc_shutdown_client(clp->cl_rpcclient);
194 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
197 if (clp->cl_machine_cred != NULL)
198 put_rpccred(clp->cl_machine_cred);
200 kfree(clp->cl_hostname);
203 dprintk("<-- nfs_free_client()\n");
207 * Release a reference to a shared client record
209 void nfs_put_client(struct nfs_client *clp)
214 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
216 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
217 list_del(&clp->cl_share_link);
218 spin_unlock(&nfs_client_lock);
220 BUG_ON(!list_empty(&clp->cl_superblocks));
222 nfs_free_client(clp);
226 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
227 static const struct in6_addr *nfs_map_ipv4_addr(const struct sockaddr *sa, struct in6_addr *addr_mapped)
229 switch (sa->sa_family) {
233 return &((const struct sockaddr_in6 *)sa)->sin6_addr;
236 ipv6_addr_set_v4mapped(((const struct sockaddr_in *)sa)->sin_addr.s_addr,
242 static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
243 const struct sockaddr *sa2)
245 const struct in6_addr *addr1;
246 const struct in6_addr *addr2;
247 struct in6_addr addr1_mapped;
248 struct in6_addr addr2_mapped;
250 addr1 = nfs_map_ipv4_addr(sa1, &addr1_mapped);
251 if (likely(addr1 != NULL)) {
252 addr2 = nfs_map_ipv4_addr(sa2, &addr2_mapped);
253 if (likely(addr2 != NULL))
254 return ipv6_addr_equal(addr1, addr2);
259 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr_in *sa1,
260 const struct sockaddr_in *sa2)
262 return sa1->sin_addr.s_addr == sa2->sin_addr.s_addr;
265 static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
266 const struct sockaddr *sa2)
268 if (unlikely(sa1->sa_family != AF_INET || sa2->sa_family != AF_INET))
270 return nfs_sockaddr_match_ipaddr4((const struct sockaddr_in *)sa1,
271 (const struct sockaddr_in *)sa2);
276 * Find a client by IP address and protocol version
277 * - returns NULL if no such client
279 struct nfs_client *nfs_find_client(const struct sockaddr *addr, u32 nfsversion)
281 struct nfs_client *clp;
283 spin_lock(&nfs_client_lock);
284 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
285 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
287 /* Don't match clients that failed to initialise properly */
288 if (clp->cl_cons_state != NFS_CS_READY)
291 /* Different NFS versions cannot share the same nfs_client */
292 if (clp->rpc_ops->version != nfsversion)
295 /* Match only the IP address, not the port number */
296 if (!nfs_sockaddr_match_ipaddr(addr, clap))
299 atomic_inc(&clp->cl_count);
300 spin_unlock(&nfs_client_lock);
303 spin_unlock(&nfs_client_lock);
308 * Find a client by IP address and protocol version
309 * - returns NULL if no such client
311 struct nfs_client *nfs_find_client_next(struct nfs_client *clp)
313 struct sockaddr *sap = (struct sockaddr *)&clp->cl_addr;
314 u32 nfsvers = clp->rpc_ops->version;
316 spin_lock(&nfs_client_lock);
317 list_for_each_entry_continue(clp, &nfs_client_list, cl_share_link) {
318 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
320 /* Don't match clients that failed to initialise properly */
321 if (clp->cl_cons_state != NFS_CS_READY)
324 /* Different NFS versions cannot share the same nfs_client */
325 if (clp->rpc_ops->version != nfsvers)
328 /* Match only the IP address, not the port number */
329 if (!nfs_sockaddr_match_ipaddr(sap, clap))
332 atomic_inc(&clp->cl_count);
333 spin_unlock(&nfs_client_lock);
336 spin_unlock(&nfs_client_lock);
341 * Find an nfs_client on the list that matches the initialisation data
344 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
346 struct nfs_client *clp;
348 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
349 /* Don't match clients that failed to initialise properly */
350 if (clp->cl_cons_state < 0)
353 /* Different NFS versions cannot share the same nfs_client */
354 if (clp->rpc_ops != data->rpc_ops)
357 if (clp->cl_proto != data->proto)
360 /* Match the full socket address */
361 if (memcmp(&clp->cl_addr, data->addr, sizeof(clp->cl_addr)) != 0)
364 atomic_inc(&clp->cl_count);
371 * Look up a client by IP address and protocol version
372 * - creates a new record if one doesn't yet exist
374 static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
376 struct nfs_client *clp, *new = NULL;
379 dprintk("--> nfs_get_client(%s,v%u)\n",
380 cl_init->hostname ?: "", cl_init->rpc_ops->version);
382 /* see if the client already exists */
384 spin_lock(&nfs_client_lock);
386 clp = nfs_match_client(cl_init);
392 spin_unlock(&nfs_client_lock);
394 new = nfs_alloc_client(cl_init);
397 return ERR_PTR(-ENOMEM);
399 /* install a new client and return with it unready */
402 list_add(&clp->cl_share_link, &nfs_client_list);
403 spin_unlock(&nfs_client_lock);
404 dprintk("--> nfs_get_client() = %p [new]\n", clp);
407 /* found an existing client
408 * - make sure it's ready before returning
411 spin_unlock(&nfs_client_lock);
414 nfs_free_client(new);
416 error = wait_event_killable(nfs_client_active_wq,
417 clp->cl_cons_state != NFS_CS_INITING);
420 return ERR_PTR(-ERESTARTSYS);
423 if (clp->cl_cons_state < NFS_CS_READY) {
424 error = clp->cl_cons_state;
426 return ERR_PTR(error);
429 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
431 dprintk("--> nfs_get_client() = %p [share]\n", clp);
436 * Mark a server as ready or failed
438 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
440 clp->cl_cons_state = state;
441 wake_up_all(&nfs_client_active_wq);
445 * Initialise the timeout values for a connection
447 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
448 unsigned int timeo, unsigned int retrans)
450 to->to_initval = timeo * HZ / 10;
451 to->to_retries = retrans;
454 case XPRT_TRANSPORT_TCP:
455 case XPRT_TRANSPORT_RDMA:
456 if (to->to_retries == 0)
457 to->to_retries = NFS_DEF_TCP_RETRANS;
458 if (to->to_initval == 0)
459 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
460 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
461 to->to_initval = NFS_MAX_TCP_TIMEOUT;
462 to->to_increment = to->to_initval;
463 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
464 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
465 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
466 if (to->to_maxval < to->to_initval)
467 to->to_maxval = to->to_initval;
468 to->to_exponential = 0;
470 case XPRT_TRANSPORT_UDP:
471 if (to->to_retries == 0)
472 to->to_retries = NFS_DEF_UDP_RETRANS;
474 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
475 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
476 to->to_initval = NFS_MAX_UDP_TIMEOUT;
477 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
478 to->to_exponential = 1;
486 * Create an RPC client handle
488 static int nfs_create_rpc_client(struct nfs_client *clp,
489 const struct rpc_timeout *timeparms,
490 rpc_authflavor_t flavor,
491 int discrtry, int noresvport)
493 struct rpc_clnt *clnt = NULL;
494 struct rpc_create_args args = {
495 .protocol = clp->cl_proto,
496 .address = (struct sockaddr *)&clp->cl_addr,
497 .addrsize = clp->cl_addrlen,
498 .timeout = timeparms,
499 .servername = clp->cl_hostname,
500 .program = &nfs_program,
501 .version = clp->rpc_ops->version,
502 .authflavor = flavor,
506 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
508 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
510 if (!IS_ERR(clp->cl_rpcclient))
513 clnt = rpc_create(&args);
515 dprintk("%s: cannot create RPC client. Error = %ld\n",
516 __func__, PTR_ERR(clnt));
517 return PTR_ERR(clnt);
520 clp->cl_rpcclient = clnt;
525 * Version 2 or 3 client destruction
527 static void nfs_destroy_server(struct nfs_server *server)
529 if (!(server->flags & NFS_MOUNT_NONLM))
530 nlmclnt_done(server->nlm_host);
534 * Version 2 or 3 lockd setup
536 static int nfs_start_lockd(struct nfs_server *server)
538 struct nlm_host *host;
539 struct nfs_client *clp = server->nfs_client;
540 struct nlmclnt_initdata nlm_init = {
541 .hostname = clp->cl_hostname,
542 .address = (struct sockaddr *)&clp->cl_addr,
543 .addrlen = clp->cl_addrlen,
544 .protocol = server->flags & NFS_MOUNT_TCP ?
545 IPPROTO_TCP : IPPROTO_UDP,
546 .nfs_version = clp->rpc_ops->version,
547 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
551 if (nlm_init.nfs_version > 3)
553 if (server->flags & NFS_MOUNT_NONLM)
556 host = nlmclnt_init(&nlm_init);
558 return PTR_ERR(host);
560 server->nlm_host = host;
561 server->destroy = nfs_destroy_server;
566 * Initialise an NFSv3 ACL client connection
568 #ifdef CONFIG_NFS_V3_ACL
569 static void nfs_init_server_aclclient(struct nfs_server *server)
571 if (server->nfs_client->rpc_ops->version != 3)
573 if (server->flags & NFS_MOUNT_NOACL)
576 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
577 if (IS_ERR(server->client_acl))
580 /* No errors! Assume that Sun nfsacls are supported */
581 server->caps |= NFS_CAP_ACLS;
585 server->caps &= ~NFS_CAP_ACLS;
588 static inline void nfs_init_server_aclclient(struct nfs_server *server)
590 server->flags &= ~NFS_MOUNT_NOACL;
591 server->caps &= ~NFS_CAP_ACLS;
596 * Create a general RPC client
598 static int nfs_init_server_rpcclient(struct nfs_server *server,
599 const struct rpc_timeout *timeo,
600 rpc_authflavor_t pseudoflavour)
602 struct nfs_client *clp = server->nfs_client;
604 server->client = rpc_clone_client(clp->cl_rpcclient);
605 if (IS_ERR(server->client)) {
606 dprintk("%s: couldn't create rpc_client!\n", __func__);
607 return PTR_ERR(server->client);
610 memcpy(&server->client->cl_timeout_default,
612 sizeof(server->client->cl_timeout_default));
613 server->client->cl_timeout = &server->client->cl_timeout_default;
615 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
616 struct rpc_auth *auth;
618 auth = rpcauth_create(pseudoflavour, server->client);
620 dprintk("%s: couldn't create credcache!\n", __func__);
621 return PTR_ERR(auth);
624 server->client->cl_softrtry = 0;
625 if (server->flags & NFS_MOUNT_SOFT)
626 server->client->cl_softrtry = 1;
632 * Initialise an NFS2 or NFS3 client
634 static int nfs_init_client(struct nfs_client *clp,
635 const struct rpc_timeout *timeparms,
636 const struct nfs_parsed_mount_data *data)
640 if (clp->cl_cons_state == NFS_CS_READY) {
641 /* the client is already initialised */
642 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
647 * Create a client RPC handle for doing FSSTAT with UNIX auth only
648 * - RFC 2623, sec 2.3.2
650 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX,
651 0, data->flags & NFS_MOUNT_NORESVPORT);
654 nfs_mark_client_ready(clp, NFS_CS_READY);
658 nfs_mark_client_ready(clp, error);
659 dprintk("<-- nfs_init_client() = xerror %d\n", error);
664 * Create a version 2 or 3 client
666 static int nfs_init_server(struct nfs_server *server,
667 const struct nfs_parsed_mount_data *data)
669 struct nfs_client_initdata cl_init = {
670 .hostname = data->nfs_server.hostname,
671 .addr = (const struct sockaddr *)&data->nfs_server.address,
672 .addrlen = data->nfs_server.addrlen,
673 .rpc_ops = &nfs_v2_clientops,
674 .proto = data->nfs_server.protocol,
676 struct rpc_timeout timeparms;
677 struct nfs_client *clp;
680 dprintk("--> nfs_init_server()\n");
683 if (data->flags & NFS_MOUNT_VER3)
684 cl_init.rpc_ops = &nfs_v3_clientops;
687 /* Allocate or find a client reference we can use */
688 clp = nfs_get_client(&cl_init);
690 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
694 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
695 data->timeo, data->retrans);
696 error = nfs_init_client(clp, &timeparms, data);
700 server->nfs_client = clp;
702 /* Initialise the client representation from the mount data */
703 server->flags = data->flags;
706 server->rsize = nfs_block_size(data->rsize, NULL);
708 server->wsize = nfs_block_size(data->wsize, NULL);
710 server->acregmin = data->acregmin * HZ;
711 server->acregmax = data->acregmax * HZ;
712 server->acdirmin = data->acdirmin * HZ;
713 server->acdirmax = data->acdirmax * HZ;
715 /* Start lockd here, before we might error out */
716 error = nfs_start_lockd(server);
720 server->port = data->nfs_server.port;
722 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
726 /* Preserve the values of mount_server-related mount options */
727 if (data->mount_server.addrlen) {
728 memcpy(&server->mountd_address, &data->mount_server.address,
729 data->mount_server.addrlen);
730 server->mountd_addrlen = data->mount_server.addrlen;
732 server->mountd_version = data->mount_server.version;
733 server->mountd_port = data->mount_server.port;
734 server->mountd_protocol = data->mount_server.protocol;
736 server->namelen = data->namlen;
737 /* Create a client RPC handle for the NFSv3 ACL management interface */
738 nfs_init_server_aclclient(server);
739 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
743 server->nfs_client = NULL;
745 dprintk("<-- nfs_init_server() = xerror %d\n", error);
750 * Load up the server record from information gained in an fsinfo record
752 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
754 unsigned long max_rpc_payload;
756 /* Work out a lot of parameters */
757 if (server->rsize == 0)
758 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
759 if (server->wsize == 0)
760 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
762 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
763 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
764 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
765 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
767 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
768 if (server->rsize > max_rpc_payload)
769 server->rsize = max_rpc_payload;
770 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
771 server->rsize = NFS_MAX_FILE_IO_SIZE;
772 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
774 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
776 if (server->wsize > max_rpc_payload)
777 server->wsize = max_rpc_payload;
778 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
779 server->wsize = NFS_MAX_FILE_IO_SIZE;
780 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
781 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
783 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
784 if (server->dtsize > PAGE_CACHE_SIZE)
785 server->dtsize = PAGE_CACHE_SIZE;
786 if (server->dtsize > server->rsize)
787 server->dtsize = server->rsize;
789 if (server->flags & NFS_MOUNT_NOAC) {
790 server->acregmin = server->acregmax = 0;
791 server->acdirmin = server->acdirmax = 0;
794 server->maxfilesize = fsinfo->maxfilesize;
796 /* We're airborne Set socket buffersize */
797 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
801 * Probe filesystem information, including the FSID on v2/v3
803 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
805 struct nfs_fsinfo fsinfo;
806 struct nfs_client *clp = server->nfs_client;
809 dprintk("--> nfs_probe_fsinfo()\n");
811 if (clp->rpc_ops->set_capabilities != NULL) {
812 error = clp->rpc_ops->set_capabilities(server, mntfh);
817 fsinfo.fattr = fattr;
818 nfs_fattr_init(fattr);
819 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
823 nfs_server_set_fsinfo(server, &fsinfo);
824 error = bdi_init(&server->backing_dev_info);
829 /* Get some general file system info */
830 if (server->namelen == 0) {
831 struct nfs_pathconf pathinfo;
833 pathinfo.fattr = fattr;
834 nfs_fattr_init(fattr);
836 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
837 server->namelen = pathinfo.max_namelen;
840 dprintk("<-- nfs_probe_fsinfo() = 0\n");
844 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
849 * Copy useful information when duplicating a server record
851 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
853 target->flags = source->flags;
854 target->acregmin = source->acregmin;
855 target->acregmax = source->acregmax;
856 target->acdirmin = source->acdirmin;
857 target->acdirmax = source->acdirmax;
858 target->caps = source->caps;
862 * Allocate and initialise a server record
864 static struct nfs_server *nfs_alloc_server(void)
866 struct nfs_server *server;
868 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
872 server->client = server->client_acl = ERR_PTR(-EINVAL);
874 /* Zero out the NFS state stuff */
875 INIT_LIST_HEAD(&server->client_link);
876 INIT_LIST_HEAD(&server->master_link);
878 atomic_set(&server->active, 0);
880 server->io_stats = nfs_alloc_iostats();
881 if (!server->io_stats) {
890 * Free up a server record
892 void nfs_free_server(struct nfs_server *server)
894 dprintk("--> nfs_free_server()\n");
896 spin_lock(&nfs_client_lock);
897 list_del(&server->client_link);
898 list_del(&server->master_link);
899 spin_unlock(&nfs_client_lock);
901 if (server->destroy != NULL)
902 server->destroy(server);
904 if (!IS_ERR(server->client_acl))
905 rpc_shutdown_client(server->client_acl);
906 if (!IS_ERR(server->client))
907 rpc_shutdown_client(server->client);
909 nfs_put_client(server->nfs_client);
911 nfs_free_iostats(server->io_stats);
912 bdi_destroy(&server->backing_dev_info);
914 nfs_release_automount_timer();
915 dprintk("<-- nfs_free_server()\n");
919 * Create a version 2 or 3 volume record
920 * - keyed on server and FSID
922 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
923 struct nfs_fh *mntfh)
925 struct nfs_server *server;
926 struct nfs_fattr fattr;
929 server = nfs_alloc_server();
931 return ERR_PTR(-ENOMEM);
933 /* Get a client representation */
934 error = nfs_init_server(server, data);
938 BUG_ON(!server->nfs_client);
939 BUG_ON(!server->nfs_client->rpc_ops);
940 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
942 /* Probe the root fh to retrieve its FSID */
943 error = nfs_probe_fsinfo(server, mntfh, &fattr);
946 if (server->nfs_client->rpc_ops->version == 3) {
947 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
948 server->namelen = NFS3_MAXNAMLEN;
949 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
950 server->caps |= NFS_CAP_READDIRPLUS;
952 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
953 server->namelen = NFS2_MAXNAMLEN;
956 if (!(fattr.valid & NFS_ATTR_FATTR)) {
957 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
959 dprintk("nfs_create_server: getattr error = %d\n", -error);
963 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
965 dprintk("Server FSID: %llx:%llx\n",
966 (unsigned long long) server->fsid.major,
967 (unsigned long long) server->fsid.minor);
969 BUG_ON(!server->nfs_client);
970 BUG_ON(!server->nfs_client->rpc_ops);
971 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
973 spin_lock(&nfs_client_lock);
974 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
975 list_add_tail(&server->master_link, &nfs_volume_list);
976 spin_unlock(&nfs_client_lock);
978 server->mount_time = jiffies;
982 nfs_free_server(server);
983 return ERR_PTR(error);
988 * Initialise an NFS4 client record
990 static int nfs4_init_client(struct nfs_client *clp,
991 const struct rpc_timeout *timeparms,
993 rpc_authflavor_t authflavour,
998 if (clp->cl_cons_state == NFS_CS_READY) {
999 /* the client is initialised already */
1000 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
1004 /* Check NFS protocol revision and initialize RPC op vector */
1005 clp->rpc_ops = &nfs_v4_clientops;
1007 error = nfs_create_rpc_client(clp, timeparms, authflavour,
1008 1, flags & NFS_MOUNT_NORESVPORT);
1011 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
1013 error = nfs_idmap_new(clp);
1015 dprintk("%s: failed to create idmapper. Error = %d\n",
1019 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
1021 nfs_mark_client_ready(clp, NFS_CS_READY);
1025 nfs_mark_client_ready(clp, error);
1026 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
1031 * Set up an NFS4 client
1033 static int nfs4_set_client(struct nfs_server *server,
1034 const char *hostname,
1035 const struct sockaddr *addr,
1036 const size_t addrlen,
1037 const char *ip_addr,
1038 rpc_authflavor_t authflavour,
1039 int proto, const struct rpc_timeout *timeparms)
1041 struct nfs_client_initdata cl_init = {
1042 .hostname = hostname,
1045 .rpc_ops = &nfs_v4_clientops,
1048 struct nfs_client *clp;
1051 dprintk("--> nfs4_set_client()\n");
1053 /* Allocate or find a client reference we can use */
1054 clp = nfs_get_client(&cl_init);
1056 error = PTR_ERR(clp);
1059 error = nfs4_init_client(clp, timeparms, ip_addr, authflavour,
1064 server->nfs_client = clp;
1065 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
1069 nfs_put_client(clp);
1071 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
1076 * Create a version 4 volume record
1078 static int nfs4_init_server(struct nfs_server *server,
1079 const struct nfs_parsed_mount_data *data)
1081 struct rpc_timeout timeparms;
1084 dprintk("--> nfs4_init_server()\n");
1086 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1087 data->timeo, data->retrans);
1089 /* Initialise the client representation from the mount data */
1090 server->flags = data->flags;
1091 server->caps |= NFS_CAP_ATOMIC_OPEN;
1093 /* Get a client record */
1094 error = nfs4_set_client(server,
1095 data->nfs_server.hostname,
1096 (const struct sockaddr *)&data->nfs_server.address,
1097 data->nfs_server.addrlen,
1098 data->client_address,
1099 data->auth_flavors[0],
1100 data->nfs_server.protocol,
1106 server->rsize = nfs_block_size(data->rsize, NULL);
1108 server->wsize = nfs_block_size(data->wsize, NULL);
1110 server->acregmin = data->acregmin * HZ;
1111 server->acregmax = data->acregmax * HZ;
1112 server->acdirmin = data->acdirmin * HZ;
1113 server->acdirmax = data->acdirmax * HZ;
1115 server->port = data->nfs_server.port;
1117 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1121 dprintk("<-- nfs4_init_server() = %d\n", error);
1126 * Create a version 4 volume record
1127 * - keyed on server and FSID
1129 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1130 struct nfs_fh *mntfh)
1132 struct nfs_fattr fattr;
1133 struct nfs_server *server;
1136 dprintk("--> nfs4_create_server()\n");
1138 server = nfs_alloc_server();
1140 return ERR_PTR(-ENOMEM);
1142 /* set up the general RPC client */
1143 error = nfs4_init_server(server, data);
1147 BUG_ON(!server->nfs_client);
1148 BUG_ON(!server->nfs_client->rpc_ops);
1149 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1151 /* Probe the root fh to retrieve its FSID */
1152 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1156 dprintk("Server FSID: %llx:%llx\n",
1157 (unsigned long long) server->fsid.major,
1158 (unsigned long long) server->fsid.minor);
1159 dprintk("Mount FH: %d\n", mntfh->size);
1161 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1165 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1166 server->namelen = NFS4_MAXNAMLEN;
1168 BUG_ON(!server->nfs_client);
1169 BUG_ON(!server->nfs_client->rpc_ops);
1170 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1172 spin_lock(&nfs_client_lock);
1173 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1174 list_add_tail(&server->master_link, &nfs_volume_list);
1175 spin_unlock(&nfs_client_lock);
1177 server->mount_time = jiffies;
1178 dprintk("<-- nfs4_create_server() = %p\n", server);
1182 nfs_free_server(server);
1183 dprintk("<-- nfs4_create_server() = error %d\n", error);
1184 return ERR_PTR(error);
1188 * Create an NFS4 referral server record
1190 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1191 struct nfs_fh *mntfh)
1193 struct nfs_client *parent_client;
1194 struct nfs_server *server, *parent_server;
1195 struct nfs_fattr fattr;
1198 dprintk("--> nfs4_create_referral_server()\n");
1200 server = nfs_alloc_server();
1202 return ERR_PTR(-ENOMEM);
1204 parent_server = NFS_SB(data->sb);
1205 parent_client = parent_server->nfs_client;
1207 /* Initialise the client representation from the parent server */
1208 nfs_server_copy_userdata(server, parent_server);
1209 server->caps |= NFS_CAP_ATOMIC_OPEN;
1211 /* Get a client representation.
1212 * Note: NFSv4 always uses TCP, */
1213 error = nfs4_set_client(server, data->hostname,
1216 parent_client->cl_ipaddr,
1218 parent_server->client->cl_xprt->prot,
1219 parent_server->client->cl_timeout);
1223 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1227 BUG_ON(!server->nfs_client);
1228 BUG_ON(!server->nfs_client->rpc_ops);
1229 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1231 /* Probe the root fh to retrieve its FSID and filehandle */
1232 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1236 /* probe the filesystem info for this server filesystem */
1237 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1241 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1242 server->namelen = NFS4_MAXNAMLEN;
1244 dprintk("Referral FSID: %llx:%llx\n",
1245 (unsigned long long) server->fsid.major,
1246 (unsigned long long) server->fsid.minor);
1248 spin_lock(&nfs_client_lock);
1249 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1250 list_add_tail(&server->master_link, &nfs_volume_list);
1251 spin_unlock(&nfs_client_lock);
1253 server->mount_time = jiffies;
1255 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1259 nfs_free_server(server);
1260 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1261 return ERR_PTR(error);
1264 #endif /* CONFIG_NFS_V4 */
1267 * Clone an NFS2, NFS3 or NFS4 server record
1269 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1271 struct nfs_fattr *fattr)
1273 struct nfs_server *server;
1274 struct nfs_fattr fattr_fsinfo;
1277 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1278 (unsigned long long) fattr->fsid.major,
1279 (unsigned long long) fattr->fsid.minor);
1281 server = nfs_alloc_server();
1283 return ERR_PTR(-ENOMEM);
1285 /* Copy data from the source */
1286 server->nfs_client = source->nfs_client;
1287 atomic_inc(&server->nfs_client->cl_count);
1288 nfs_server_copy_userdata(server, source);
1290 server->fsid = fattr->fsid;
1292 error = nfs_init_server_rpcclient(server,
1293 source->client->cl_timeout,
1294 source->client->cl_auth->au_flavor);
1296 goto out_free_server;
1297 if (!IS_ERR(source->client_acl))
1298 nfs_init_server_aclclient(server);
1300 /* probe the filesystem info for this server filesystem */
1301 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1303 goto out_free_server;
1305 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1306 server->namelen = NFS4_MAXNAMLEN;
1308 dprintk("Cloned FSID: %llx:%llx\n",
1309 (unsigned long long) server->fsid.major,
1310 (unsigned long long) server->fsid.minor);
1312 error = nfs_start_lockd(server);
1314 goto out_free_server;
1316 spin_lock(&nfs_client_lock);
1317 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1318 list_add_tail(&server->master_link, &nfs_volume_list);
1319 spin_unlock(&nfs_client_lock);
1321 server->mount_time = jiffies;
1323 dprintk("<-- nfs_clone_server() = %p\n", server);
1327 nfs_free_server(server);
1328 dprintk("<-- nfs_clone_server() = error %d\n", error);
1329 return ERR_PTR(error);
1332 #ifdef CONFIG_PROC_FS
1333 static struct proc_dir_entry *proc_fs_nfs;
1335 static int nfs_server_list_open(struct inode *inode, struct file *file);
1336 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1337 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1338 static void nfs_server_list_stop(struct seq_file *p, void *v);
1339 static int nfs_server_list_show(struct seq_file *m, void *v);
1341 static struct seq_operations nfs_server_list_ops = {
1342 .start = nfs_server_list_start,
1343 .next = nfs_server_list_next,
1344 .stop = nfs_server_list_stop,
1345 .show = nfs_server_list_show,
1348 static const struct file_operations nfs_server_list_fops = {
1349 .open = nfs_server_list_open,
1351 .llseek = seq_lseek,
1352 .release = seq_release,
1353 .owner = THIS_MODULE,
1356 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1357 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1358 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1359 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1360 static int nfs_volume_list_show(struct seq_file *m, void *v);
1362 static struct seq_operations nfs_volume_list_ops = {
1363 .start = nfs_volume_list_start,
1364 .next = nfs_volume_list_next,
1365 .stop = nfs_volume_list_stop,
1366 .show = nfs_volume_list_show,
1369 static const struct file_operations nfs_volume_list_fops = {
1370 .open = nfs_volume_list_open,
1372 .llseek = seq_lseek,
1373 .release = seq_release,
1374 .owner = THIS_MODULE,
1378 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1381 static int nfs_server_list_open(struct inode *inode, struct file *file)
1386 ret = seq_open(file, &nfs_server_list_ops);
1390 m = file->private_data;
1391 m->private = PDE(inode)->data;
1397 * set up the iterator to start reading from the server list and return the first item
1399 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1401 /* lock the list against modification */
1402 spin_lock(&nfs_client_lock);
1403 return seq_list_start_head(&nfs_client_list, *_pos);
1407 * move to next server
1409 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1411 return seq_list_next(v, &nfs_client_list, pos);
1415 * clean up after reading from the transports list
1417 static void nfs_server_list_stop(struct seq_file *p, void *v)
1419 spin_unlock(&nfs_client_lock);
1423 * display a header line followed by a load of call lines
1425 static int nfs_server_list_show(struct seq_file *m, void *v)
1427 struct nfs_client *clp;
1429 /* display header on line 1 */
1430 if (v == &nfs_client_list) {
1431 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1435 /* display one transport per line on subsequent lines */
1436 clp = list_entry(v, struct nfs_client, cl_share_link);
1438 seq_printf(m, "v%u %s %s %3d %s\n",
1439 clp->rpc_ops->version,
1440 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1441 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1442 atomic_read(&clp->cl_count),
1449 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1451 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1456 ret = seq_open(file, &nfs_volume_list_ops);
1460 m = file->private_data;
1461 m->private = PDE(inode)->data;
1467 * set up the iterator to start reading from the volume list and return the first item
1469 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1471 /* lock the list against modification */
1472 spin_lock(&nfs_client_lock);
1473 return seq_list_start_head(&nfs_volume_list, *_pos);
1477 * move to next volume
1479 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1481 return seq_list_next(v, &nfs_volume_list, pos);
1485 * clean up after reading from the transports list
1487 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1489 spin_unlock(&nfs_client_lock);
1493 * display a header line followed by a load of call lines
1495 static int nfs_volume_list_show(struct seq_file *m, void *v)
1497 struct nfs_server *server;
1498 struct nfs_client *clp;
1499 char dev[8], fsid[17];
1501 /* display header on line 1 */
1502 if (v == &nfs_volume_list) {
1503 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1506 /* display one transport per line on subsequent lines */
1507 server = list_entry(v, struct nfs_server, master_link);
1508 clp = server->nfs_client;
1510 snprintf(dev, 8, "%u:%u",
1511 MAJOR(server->s_dev), MINOR(server->s_dev));
1513 snprintf(fsid, 17, "%llx:%llx",
1514 (unsigned long long) server->fsid.major,
1515 (unsigned long long) server->fsid.minor);
1517 seq_printf(m, "v%u %s %s %-7s %-17s\n",
1518 clp->rpc_ops->version,
1519 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1520 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1528 * initialise the /proc/fs/nfsfs/ directory
1530 int __init nfs_fs_proc_init(void)
1532 struct proc_dir_entry *p;
1534 proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1538 proc_fs_nfs->owner = THIS_MODULE;
1540 /* a file of servers with which we're dealing */
1541 p = proc_create("servers", S_IFREG|S_IRUGO,
1542 proc_fs_nfs, &nfs_server_list_fops);
1546 /* a file of volumes that we have mounted */
1547 p = proc_create("volumes", S_IFREG|S_IRUGO,
1548 proc_fs_nfs, &nfs_volume_list_fops);
1554 remove_proc_entry("servers", proc_fs_nfs);
1556 remove_proc_entry("fs/nfsfs", NULL);
1562 * clean up the /proc/fs/nfsfs/ directory
1564 void nfs_fs_proc_exit(void)
1566 remove_proc_entry("volumes", proc_fs_nfs);
1567 remove_proc_entry("servers", proc_fs_nfs);
1568 remove_proc_entry("fs/nfsfs", NULL);
1571 #endif /* CONFIG_PROC_FS */