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_in *addr;
101 const struct nfs_rpc_ops *rpc_ops;
105 * Allocate a shared client record
107 * Since these are allocated/deallocated very rarely, we don't
108 * bother putting them in a slab cache...
110 static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
112 struct nfs_client *clp;
114 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
117 clp->rpc_ops = cl_init->rpc_ops;
119 if (cl_init->rpc_ops->version == 4) {
120 if (nfs_callback_up() < 0)
122 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
125 atomic_set(&clp->cl_count, 1);
126 clp->cl_cons_state = NFS_CS_INITING;
128 memcpy(&clp->cl_addr, cl_init->addr, sizeof(clp->cl_addr));
130 if (cl_init->hostname) {
131 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
132 if (!clp->cl_hostname)
136 INIT_LIST_HEAD(&clp->cl_superblocks);
137 clp->cl_rpcclient = ERR_PTR(-EINVAL);
140 init_rwsem(&clp->cl_sem);
141 INIT_LIST_HEAD(&clp->cl_delegations);
142 spin_lock_init(&clp->cl_lock);
143 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
144 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
145 clp->cl_boot_time = CURRENT_TIME;
146 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
152 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
160 static void nfs4_shutdown_client(struct nfs_client *clp)
163 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
164 nfs4_kill_renewd(clp);
165 BUG_ON(!RB_EMPTY_ROOT(&clp->cl_state_owners));
166 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
167 nfs_idmap_delete(clp);
172 * Destroy a shared client record
174 static void nfs_free_client(struct nfs_client *clp)
176 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
178 nfs4_shutdown_client(clp);
180 /* -EIO all pending I/O */
181 if (!IS_ERR(clp->cl_rpcclient))
182 rpc_shutdown_client(clp->cl_rpcclient);
184 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
187 kfree(clp->cl_hostname);
190 dprintk("<-- nfs_free_client()\n");
194 * Release a reference to a shared client record
196 void nfs_put_client(struct nfs_client *clp)
201 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
203 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
204 list_del(&clp->cl_share_link);
205 spin_unlock(&nfs_client_lock);
207 BUG_ON(!list_empty(&clp->cl_superblocks));
209 nfs_free_client(clp);
213 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr_in *sa1,
214 const struct sockaddr_in *sa2)
216 return sa1->sin_addr.s_addr == sa2->sin_addr.s_addr;
219 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr_in6 *sa1,
220 const struct sockaddr_in6 *sa2)
222 return ipv6_addr_equal(&sa1->sin6_addr, &sa2->sin6_addr);
225 static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
226 const struct sockaddr *sa2)
228 switch (sa1->sa_family) {
230 return nfs_sockaddr_match_ipaddr4((const struct sockaddr_in *)sa1,
231 (const struct sockaddr_in *)sa2);
233 return nfs_sockaddr_match_ipaddr6((const struct sockaddr_in6 *)sa1,
234 (const struct sockaddr_in6 *)sa2);
240 * Find a client by IP address and protocol version
241 * - returns NULL if no such client
243 struct nfs_client *_nfs_find_client(const struct sockaddr *addr, int nfsversion)
245 struct nfs_client *clp;
247 spin_lock(&nfs_client_lock);
248 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
249 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
251 /* Don't match clients that failed to initialise properly */
252 if (clp->cl_cons_state != NFS_CS_READY)
255 /* Different NFS versions cannot share the same nfs_client */
256 if (clp->rpc_ops->version != nfsversion)
259 if (addr->sa_family != clap->sa_family)
261 /* Match only the IP address, not the port number */
262 if (!nfs_sockaddr_match_ipaddr(addr, clap))
265 atomic_inc(&clp->cl_count);
266 spin_unlock(&nfs_client_lock);
269 spin_unlock(&nfs_client_lock);
273 struct nfs_client *nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
275 return _nfs_find_client((const struct sockaddr *)addr, nfsversion);
279 * Find an nfs_client on the list that matches the initialisation data
282 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
284 struct nfs_client *clp;
286 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
287 /* Don't match clients that failed to initialise properly */
288 if (clp->cl_cons_state < 0)
291 /* Different NFS versions cannot share the same nfs_client */
292 if (clp->rpc_ops != data->rpc_ops)
295 /* Match the full socket address */
296 if (memcmp(&clp->cl_addr, data->addr, sizeof(clp->cl_addr)) != 0)
299 atomic_inc(&clp->cl_count);
306 * Look up a client by IP address and protocol version
307 * - creates a new record if one doesn't yet exist
309 static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
311 struct nfs_client *clp, *new = NULL;
314 dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT":%d,%u)\n",
315 cl_init->hostname ?: "", NIPQUAD(cl_init->addr->sin_addr),
316 cl_init->addr->sin_port, cl_init->rpc_ops->version);
318 /* see if the client already exists */
320 spin_lock(&nfs_client_lock);
322 clp = nfs_match_client(cl_init);
328 spin_unlock(&nfs_client_lock);
330 new = nfs_alloc_client(cl_init);
333 return ERR_PTR(-ENOMEM);
335 /* install a new client and return with it unready */
338 list_add(&clp->cl_share_link, &nfs_client_list);
339 spin_unlock(&nfs_client_lock);
340 dprintk("--> nfs_get_client() = %p [new]\n", clp);
343 /* found an existing client
344 * - make sure it's ready before returning
347 spin_unlock(&nfs_client_lock);
350 nfs_free_client(new);
352 error = wait_event_interruptible(nfs_client_active_wq,
353 clp->cl_cons_state != NFS_CS_INITING);
356 return ERR_PTR(-ERESTARTSYS);
359 if (clp->cl_cons_state < NFS_CS_READY) {
360 error = clp->cl_cons_state;
362 return ERR_PTR(error);
365 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
367 dprintk("--> nfs_get_client() = %p [share]\n", clp);
372 * Mark a server as ready or failed
374 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
376 clp->cl_cons_state = state;
377 wake_up_all(&nfs_client_active_wq);
381 * Initialise the timeout values for a connection
383 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
384 unsigned int timeo, unsigned int retrans)
386 to->to_initval = timeo * HZ / 10;
387 to->to_retries = retrans;
392 case XPRT_TRANSPORT_TCP:
393 case XPRT_TRANSPORT_RDMA:
395 to->to_initval = 60 * HZ;
396 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
397 to->to_initval = NFS_MAX_TCP_TIMEOUT;
398 to->to_increment = to->to_initval;
399 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
400 to->to_exponential = 0;
402 case XPRT_TRANSPORT_UDP:
405 to->to_initval = 11 * HZ / 10;
406 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
407 to->to_initval = NFS_MAX_UDP_TIMEOUT;
408 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
409 to->to_exponential = 1;
415 * Create an RPC client handle
417 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
419 unsigned int retrans,
420 rpc_authflavor_t flavor,
423 struct rpc_timeout timeparms;
424 struct rpc_clnt *clnt = NULL;
425 struct rpc_create_args args = {
427 .address = (struct sockaddr *)&clp->cl_addr,
428 .addrsize = sizeof(clp->cl_addr),
429 .timeout = &timeparms,
430 .servername = clp->cl_hostname,
431 .program = &nfs_program,
432 .version = clp->rpc_ops->version,
433 .authflavor = flavor,
437 if (!IS_ERR(clp->cl_rpcclient))
440 nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
441 clp->retrans_timeo = timeparms.to_initval;
442 clp->retrans_count = timeparms.to_retries;
444 clnt = rpc_create(&args);
446 dprintk("%s: cannot create RPC client. Error = %ld\n",
447 __FUNCTION__, PTR_ERR(clnt));
448 return PTR_ERR(clnt);
451 clp->cl_rpcclient = clnt;
456 * Version 2 or 3 client destruction
458 static void nfs_destroy_server(struct nfs_server *server)
460 if (!(server->flags & NFS_MOUNT_NONLM))
461 lockd_down(); /* release rpc.lockd */
465 * Version 2 or 3 lockd setup
467 static int nfs_start_lockd(struct nfs_server *server)
471 if (server->nfs_client->rpc_ops->version > 3)
473 if (server->flags & NFS_MOUNT_NONLM)
475 error = lockd_up((server->flags & NFS_MOUNT_TCP) ?
476 IPPROTO_TCP : IPPROTO_UDP);
478 server->flags |= NFS_MOUNT_NONLM;
480 server->destroy = nfs_destroy_server;
486 * Initialise an NFSv3 ACL client connection
488 #ifdef CONFIG_NFS_V3_ACL
489 static void nfs_init_server_aclclient(struct nfs_server *server)
491 if (server->nfs_client->rpc_ops->version != 3)
493 if (server->flags & NFS_MOUNT_NOACL)
496 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
497 if (IS_ERR(server->client_acl))
500 /* No errors! Assume that Sun nfsacls are supported */
501 server->caps |= NFS_CAP_ACLS;
505 server->caps &= ~NFS_CAP_ACLS;
508 static inline void nfs_init_server_aclclient(struct nfs_server *server)
510 server->flags &= ~NFS_MOUNT_NOACL;
511 server->caps &= ~NFS_CAP_ACLS;
516 * Create a general RPC client
518 static int nfs_init_server_rpcclient(struct nfs_server *server, rpc_authflavor_t pseudoflavour)
520 struct nfs_client *clp = server->nfs_client;
522 server->client = rpc_clone_client(clp->cl_rpcclient);
523 if (IS_ERR(server->client)) {
524 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
525 return PTR_ERR(server->client);
528 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
529 struct rpc_auth *auth;
531 auth = rpcauth_create(pseudoflavour, server->client);
533 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
534 return PTR_ERR(auth);
537 server->client->cl_softrtry = 0;
538 if (server->flags & NFS_MOUNT_SOFT)
539 server->client->cl_softrtry = 1;
541 server->client->cl_intr = 0;
542 if (server->flags & NFS4_MOUNT_INTR)
543 server->client->cl_intr = 1;
549 * Initialise an NFS2 or NFS3 client
551 static int nfs_init_client(struct nfs_client *clp,
552 const struct nfs_parsed_mount_data *data)
556 if (clp->cl_cons_state == NFS_CS_READY) {
557 /* the client is already initialised */
558 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
563 * Create a client RPC handle for doing FSSTAT with UNIX auth only
564 * - RFC 2623, sec 2.3.2
566 error = nfs_create_rpc_client(clp, data->nfs_server.protocol,
567 data->timeo, data->retrans, RPC_AUTH_UNIX, 0);
570 nfs_mark_client_ready(clp, NFS_CS_READY);
574 nfs_mark_client_ready(clp, error);
575 dprintk("<-- nfs_init_client() = xerror %d\n", error);
580 * Create a version 2 or 3 client
582 static int nfs_init_server(struct nfs_server *server,
583 const struct nfs_parsed_mount_data *data)
585 struct nfs_client_initdata cl_init = {
586 .hostname = data->nfs_server.hostname,
587 .addr = &data->nfs_server.address,
588 .rpc_ops = &nfs_v2_clientops,
590 struct nfs_client *clp;
593 dprintk("--> nfs_init_server()\n");
596 if (data->flags & NFS_MOUNT_VER3)
597 cl_init.rpc_ops = &nfs_v3_clientops;
600 /* Allocate or find a client reference we can use */
601 clp = nfs_get_client(&cl_init);
603 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
607 error = nfs_init_client(clp, data);
611 server->nfs_client = clp;
613 /* Initialise the client representation from the mount data */
614 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
617 server->rsize = nfs_block_size(data->rsize, NULL);
619 server->wsize = nfs_block_size(data->wsize, NULL);
621 server->acregmin = data->acregmin * HZ;
622 server->acregmax = data->acregmax * HZ;
623 server->acdirmin = data->acdirmin * HZ;
624 server->acdirmax = data->acdirmax * HZ;
626 /* Start lockd here, before we might error out */
627 error = nfs_start_lockd(server);
631 error = nfs_init_server_rpcclient(server, data->auth_flavors[0]);
635 server->namelen = data->namlen;
636 /* Create a client RPC handle for the NFSv3 ACL management interface */
637 nfs_init_server_aclclient(server);
638 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
642 server->nfs_client = NULL;
644 dprintk("<-- nfs_init_server() = xerror %d\n", error);
649 * Load up the server record from information gained in an fsinfo record
651 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
653 unsigned long max_rpc_payload;
655 /* Work out a lot of parameters */
656 if (server->rsize == 0)
657 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
658 if (server->wsize == 0)
659 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
661 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
662 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
663 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
664 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
666 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
667 if (server->rsize > max_rpc_payload)
668 server->rsize = max_rpc_payload;
669 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
670 server->rsize = NFS_MAX_FILE_IO_SIZE;
671 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
673 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
675 if (server->wsize > max_rpc_payload)
676 server->wsize = max_rpc_payload;
677 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
678 server->wsize = NFS_MAX_FILE_IO_SIZE;
679 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
680 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
682 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
683 if (server->dtsize > PAGE_CACHE_SIZE)
684 server->dtsize = PAGE_CACHE_SIZE;
685 if (server->dtsize > server->rsize)
686 server->dtsize = server->rsize;
688 if (server->flags & NFS_MOUNT_NOAC) {
689 server->acregmin = server->acregmax = 0;
690 server->acdirmin = server->acdirmax = 0;
693 server->maxfilesize = fsinfo->maxfilesize;
695 /* We're airborne Set socket buffersize */
696 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
700 * Probe filesystem information, including the FSID on v2/v3
702 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
704 struct nfs_fsinfo fsinfo;
705 struct nfs_client *clp = server->nfs_client;
708 dprintk("--> nfs_probe_fsinfo()\n");
710 if (clp->rpc_ops->set_capabilities != NULL) {
711 error = clp->rpc_ops->set_capabilities(server, mntfh);
716 fsinfo.fattr = fattr;
717 nfs_fattr_init(fattr);
718 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
722 nfs_server_set_fsinfo(server, &fsinfo);
723 error = bdi_init(&server->backing_dev_info);
728 /* Get some general file system info */
729 if (server->namelen == 0) {
730 struct nfs_pathconf pathinfo;
732 pathinfo.fattr = fattr;
733 nfs_fattr_init(fattr);
735 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
736 server->namelen = pathinfo.max_namelen;
739 dprintk("<-- nfs_probe_fsinfo() = 0\n");
743 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
748 * Copy useful information when duplicating a server record
750 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
752 target->flags = source->flags;
753 target->acregmin = source->acregmin;
754 target->acregmax = source->acregmax;
755 target->acdirmin = source->acdirmin;
756 target->acdirmax = source->acdirmax;
757 target->caps = source->caps;
761 * Allocate and initialise a server record
763 static struct nfs_server *nfs_alloc_server(void)
765 struct nfs_server *server;
767 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
771 server->client = server->client_acl = ERR_PTR(-EINVAL);
773 /* Zero out the NFS state stuff */
774 INIT_LIST_HEAD(&server->client_link);
775 INIT_LIST_HEAD(&server->master_link);
777 init_waitqueue_head(&server->active_wq);
778 atomic_set(&server->active, 0);
780 server->io_stats = nfs_alloc_iostats();
781 if (!server->io_stats) {
790 * Free up a server record
792 void nfs_free_server(struct nfs_server *server)
794 dprintk("--> nfs_free_server()\n");
796 spin_lock(&nfs_client_lock);
797 list_del(&server->client_link);
798 list_del(&server->master_link);
799 spin_unlock(&nfs_client_lock);
801 if (server->destroy != NULL)
802 server->destroy(server);
804 if (!IS_ERR(server->client_acl))
805 rpc_shutdown_client(server->client_acl);
806 if (!IS_ERR(server->client))
807 rpc_shutdown_client(server->client);
809 nfs_put_client(server->nfs_client);
811 nfs_free_iostats(server->io_stats);
812 bdi_destroy(&server->backing_dev_info);
814 nfs_release_automount_timer();
815 dprintk("<-- nfs_free_server()\n");
819 * Create a version 2 or 3 volume record
820 * - keyed on server and FSID
822 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
823 struct nfs_fh *mntfh)
825 struct nfs_server *server;
826 struct nfs_fattr fattr;
829 server = nfs_alloc_server();
831 return ERR_PTR(-ENOMEM);
833 /* Get a client representation */
834 error = nfs_init_server(server, data);
838 BUG_ON(!server->nfs_client);
839 BUG_ON(!server->nfs_client->rpc_ops);
840 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
842 /* Probe the root fh to retrieve its FSID */
843 error = nfs_probe_fsinfo(server, mntfh, &fattr);
846 if (server->nfs_client->rpc_ops->version == 3) {
847 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
848 server->namelen = NFS3_MAXNAMLEN;
849 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
850 server->caps |= NFS_CAP_READDIRPLUS;
852 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
853 server->namelen = NFS2_MAXNAMLEN;
856 if (!(fattr.valid & NFS_ATTR_FATTR)) {
857 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
859 dprintk("nfs_create_server: getattr error = %d\n", -error);
863 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
865 dprintk("Server FSID: %llx:%llx\n",
866 (unsigned long long) server->fsid.major,
867 (unsigned long long) server->fsid.minor);
869 BUG_ON(!server->nfs_client);
870 BUG_ON(!server->nfs_client->rpc_ops);
871 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
873 spin_lock(&nfs_client_lock);
874 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
875 list_add_tail(&server->master_link, &nfs_volume_list);
876 spin_unlock(&nfs_client_lock);
878 server->mount_time = jiffies;
882 nfs_free_server(server);
883 return ERR_PTR(error);
888 * Initialise an NFS4 client record
890 static int nfs4_init_client(struct nfs_client *clp,
891 int proto, int timeo, int retrans,
893 rpc_authflavor_t authflavour)
897 if (clp->cl_cons_state == NFS_CS_READY) {
898 /* the client is initialised already */
899 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
903 /* Check NFS protocol revision and initialize RPC op vector */
904 clp->rpc_ops = &nfs_v4_clientops;
906 error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour,
907 RPC_CLNT_CREATE_DISCRTRY);
910 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
912 error = nfs_idmap_new(clp);
914 dprintk("%s: failed to create idmapper. Error = %d\n",
915 __FUNCTION__, error);
918 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
920 nfs_mark_client_ready(clp, NFS_CS_READY);
924 nfs_mark_client_ready(clp, error);
925 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
930 * Set up an NFS4 client
932 static int nfs4_set_client(struct nfs_server *server,
933 const char *hostname, const struct sockaddr_in *addr,
935 rpc_authflavor_t authflavour,
936 int proto, int timeo, int retrans)
938 struct nfs_client_initdata cl_init = {
939 .hostname = hostname,
941 .rpc_ops = &nfs_v4_clientops,
943 struct nfs_client *clp;
946 dprintk("--> nfs4_set_client()\n");
948 /* Allocate or find a client reference we can use */
949 clp = nfs_get_client(&cl_init);
951 error = PTR_ERR(clp);
954 error = nfs4_init_client(clp, proto, timeo, retrans, ip_addr, authflavour);
958 server->nfs_client = clp;
959 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
965 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
970 * Create a version 4 volume record
972 static int nfs4_init_server(struct nfs_server *server,
973 const struct nfs_parsed_mount_data *data)
977 dprintk("--> nfs4_init_server()\n");
979 /* Initialise the client representation from the mount data */
980 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
981 server->caps |= NFS_CAP_ATOMIC_OPEN;
984 server->rsize = nfs_block_size(data->rsize, NULL);
986 server->wsize = nfs_block_size(data->wsize, NULL);
988 server->acregmin = data->acregmin * HZ;
989 server->acregmax = data->acregmax * HZ;
990 server->acdirmin = data->acdirmin * HZ;
991 server->acdirmax = data->acdirmax * HZ;
993 error = nfs_init_server_rpcclient(server, data->auth_flavors[0]);
996 dprintk("<-- nfs4_init_server() = %d\n", error);
1001 * Create a version 4 volume record
1002 * - keyed on server and FSID
1004 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1005 struct nfs_fh *mntfh)
1007 struct nfs_fattr fattr;
1008 struct nfs_server *server;
1011 dprintk("--> nfs4_create_server()\n");
1013 server = nfs_alloc_server();
1015 return ERR_PTR(-ENOMEM);
1017 /* Get a client record */
1018 error = nfs4_set_client(server,
1019 data->nfs_server.hostname,
1020 &data->nfs_server.address,
1021 data->client_address,
1022 data->auth_flavors[0],
1023 data->nfs_server.protocol,
1024 data->timeo, data->retrans);
1028 /* set up the general RPC client */
1029 error = nfs4_init_server(server, data);
1033 BUG_ON(!server->nfs_client);
1034 BUG_ON(!server->nfs_client->rpc_ops);
1035 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1037 /* Probe the root fh to retrieve its FSID */
1038 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1042 dprintk("Server FSID: %llx:%llx\n",
1043 (unsigned long long) server->fsid.major,
1044 (unsigned long long) server->fsid.minor);
1045 dprintk("Mount FH: %d\n", mntfh->size);
1047 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1051 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1052 server->namelen = NFS4_MAXNAMLEN;
1054 BUG_ON(!server->nfs_client);
1055 BUG_ON(!server->nfs_client->rpc_ops);
1056 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1058 spin_lock(&nfs_client_lock);
1059 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1060 list_add_tail(&server->master_link, &nfs_volume_list);
1061 spin_unlock(&nfs_client_lock);
1063 server->mount_time = jiffies;
1064 dprintk("<-- nfs4_create_server() = %p\n", server);
1068 nfs_free_server(server);
1069 dprintk("<-- nfs4_create_server() = error %d\n", error);
1070 return ERR_PTR(error);
1074 * Create an NFS4 referral server record
1076 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1077 struct nfs_fh *mntfh)
1079 struct nfs_client *parent_client;
1080 struct nfs_server *server, *parent_server;
1081 struct nfs_fattr fattr;
1084 dprintk("--> nfs4_create_referral_server()\n");
1086 server = nfs_alloc_server();
1088 return ERR_PTR(-ENOMEM);
1090 parent_server = NFS_SB(data->sb);
1091 parent_client = parent_server->nfs_client;
1093 /* Get a client representation.
1094 * Note: NFSv4 always uses TCP, */
1095 error = nfs4_set_client(server, data->hostname, data->addr,
1096 parent_client->cl_ipaddr,
1098 parent_server->client->cl_xprt->prot,
1099 parent_client->retrans_timeo,
1100 parent_client->retrans_count);
1104 /* Initialise the client representation from the parent server */
1105 nfs_server_copy_userdata(server, parent_server);
1106 server->caps |= NFS_CAP_ATOMIC_OPEN;
1108 error = nfs_init_server_rpcclient(server, data->authflavor);
1112 BUG_ON(!server->nfs_client);
1113 BUG_ON(!server->nfs_client->rpc_ops);
1114 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1116 /* Probe the root fh to retrieve its FSID and filehandle */
1117 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1121 /* probe the filesystem info for this server filesystem */
1122 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1126 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1127 server->namelen = NFS4_MAXNAMLEN;
1129 dprintk("Referral FSID: %llx:%llx\n",
1130 (unsigned long long) server->fsid.major,
1131 (unsigned long long) server->fsid.minor);
1133 spin_lock(&nfs_client_lock);
1134 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1135 list_add_tail(&server->master_link, &nfs_volume_list);
1136 spin_unlock(&nfs_client_lock);
1138 server->mount_time = jiffies;
1140 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1144 nfs_free_server(server);
1145 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1146 return ERR_PTR(error);
1149 #endif /* CONFIG_NFS_V4 */
1152 * Clone an NFS2, NFS3 or NFS4 server record
1154 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1156 struct nfs_fattr *fattr)
1158 struct nfs_server *server;
1159 struct nfs_fattr fattr_fsinfo;
1162 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1163 (unsigned long long) fattr->fsid.major,
1164 (unsigned long long) fattr->fsid.minor);
1166 server = nfs_alloc_server();
1168 return ERR_PTR(-ENOMEM);
1170 /* Copy data from the source */
1171 server->nfs_client = source->nfs_client;
1172 atomic_inc(&server->nfs_client->cl_count);
1173 nfs_server_copy_userdata(server, source);
1175 server->fsid = fattr->fsid;
1177 error = nfs_init_server_rpcclient(server, source->client->cl_auth->au_flavor);
1179 goto out_free_server;
1180 if (!IS_ERR(source->client_acl))
1181 nfs_init_server_aclclient(server);
1183 /* probe the filesystem info for this server filesystem */
1184 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1186 goto out_free_server;
1188 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1189 server->namelen = NFS4_MAXNAMLEN;
1191 dprintk("Cloned FSID: %llx:%llx\n",
1192 (unsigned long long) server->fsid.major,
1193 (unsigned long long) server->fsid.minor);
1195 error = nfs_start_lockd(server);
1197 goto out_free_server;
1199 spin_lock(&nfs_client_lock);
1200 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1201 list_add_tail(&server->master_link, &nfs_volume_list);
1202 spin_unlock(&nfs_client_lock);
1204 server->mount_time = jiffies;
1206 dprintk("<-- nfs_clone_server() = %p\n", server);
1210 nfs_free_server(server);
1211 dprintk("<-- nfs_clone_server() = error %d\n", error);
1212 return ERR_PTR(error);
1215 #ifdef CONFIG_PROC_FS
1216 static struct proc_dir_entry *proc_fs_nfs;
1218 static int nfs_server_list_open(struct inode *inode, struct file *file);
1219 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1220 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1221 static void nfs_server_list_stop(struct seq_file *p, void *v);
1222 static int nfs_server_list_show(struct seq_file *m, void *v);
1224 static struct seq_operations nfs_server_list_ops = {
1225 .start = nfs_server_list_start,
1226 .next = nfs_server_list_next,
1227 .stop = nfs_server_list_stop,
1228 .show = nfs_server_list_show,
1231 static const struct file_operations nfs_server_list_fops = {
1232 .open = nfs_server_list_open,
1234 .llseek = seq_lseek,
1235 .release = seq_release,
1238 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1239 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1240 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1241 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1242 static int nfs_volume_list_show(struct seq_file *m, void *v);
1244 static struct seq_operations nfs_volume_list_ops = {
1245 .start = nfs_volume_list_start,
1246 .next = nfs_volume_list_next,
1247 .stop = nfs_volume_list_stop,
1248 .show = nfs_volume_list_show,
1251 static const struct file_operations nfs_volume_list_fops = {
1252 .open = nfs_volume_list_open,
1254 .llseek = seq_lseek,
1255 .release = seq_release,
1259 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1262 static int nfs_server_list_open(struct inode *inode, struct file *file)
1267 ret = seq_open(file, &nfs_server_list_ops);
1271 m = file->private_data;
1272 m->private = PDE(inode)->data;
1278 * set up the iterator to start reading from the server list and return the first item
1280 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1282 /* lock the list against modification */
1283 spin_lock(&nfs_client_lock);
1284 return seq_list_start_head(&nfs_client_list, *_pos);
1288 * move to next server
1290 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1292 return seq_list_next(v, &nfs_client_list, pos);
1296 * clean up after reading from the transports list
1298 static void nfs_server_list_stop(struct seq_file *p, void *v)
1300 spin_unlock(&nfs_client_lock);
1304 * display a header line followed by a load of call lines
1306 static int nfs_server_list_show(struct seq_file *m, void *v)
1308 struct nfs_client *clp;
1310 /* display header on line 1 */
1311 if (v == &nfs_client_list) {
1312 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1316 /* display one transport per line on subsequent lines */
1317 clp = list_entry(v, struct nfs_client, cl_share_link);
1319 seq_printf(m, "v%u %s %s %3d %s\n",
1320 clp->rpc_ops->version,
1321 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1322 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1323 atomic_read(&clp->cl_count),
1330 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1332 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1337 ret = seq_open(file, &nfs_volume_list_ops);
1341 m = file->private_data;
1342 m->private = PDE(inode)->data;
1348 * set up the iterator to start reading from the volume list and return the first item
1350 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1352 /* lock the list against modification */
1353 spin_lock(&nfs_client_lock);
1354 return seq_list_start_head(&nfs_volume_list, *_pos);
1358 * move to next volume
1360 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1362 return seq_list_next(v, &nfs_volume_list, pos);
1366 * clean up after reading from the transports list
1368 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1370 spin_unlock(&nfs_client_lock);
1374 * display a header line followed by a load of call lines
1376 static int nfs_volume_list_show(struct seq_file *m, void *v)
1378 struct nfs_server *server;
1379 struct nfs_client *clp;
1380 char dev[8], fsid[17];
1382 /* display header on line 1 */
1383 if (v == &nfs_volume_list) {
1384 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1387 /* display one transport per line on subsequent lines */
1388 server = list_entry(v, struct nfs_server, master_link);
1389 clp = server->nfs_client;
1391 snprintf(dev, 8, "%u:%u",
1392 MAJOR(server->s_dev), MINOR(server->s_dev));
1394 snprintf(fsid, 17, "%llx:%llx",
1395 (unsigned long long) server->fsid.major,
1396 (unsigned long long) server->fsid.minor);
1398 seq_printf(m, "v%u %s %s %-7s %-17s\n",
1399 clp->rpc_ops->version,
1400 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1401 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1409 * initialise the /proc/fs/nfsfs/ directory
1411 int __init nfs_fs_proc_init(void)
1413 struct proc_dir_entry *p;
1415 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1419 proc_fs_nfs->owner = THIS_MODULE;
1421 /* a file of servers with which we're dealing */
1422 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1426 p->proc_fops = &nfs_server_list_fops;
1427 p->owner = THIS_MODULE;
1429 /* a file of volumes that we have mounted */
1430 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1434 p->proc_fops = &nfs_volume_list_fops;
1435 p->owner = THIS_MODULE;
1439 remove_proc_entry("servers", proc_fs_nfs);
1441 remove_proc_entry("nfsfs", proc_root_fs);
1447 * clean up the /proc/fs/nfsfs/ directory
1449 void nfs_fs_proc_exit(void)
1451 remove_proc_entry("volumes", proc_fs_nfs);
1452 remove_proc_entry("servers", proc_fs_nfs);
1453 remove_proc_entry("nfsfs", proc_root_fs);
1456 #endif /* CONFIG_PROC_FS */