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"
50 #define NFSDBG_FACILITY NFSDBG_CLIENT
52 static DEFINE_SPINLOCK(nfs_client_lock);
53 static LIST_HEAD(nfs_client_list);
54 static LIST_HEAD(nfs_volume_list);
55 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
60 static struct rpc_version *nfs_version[5] = {
70 struct rpc_program nfs_program = {
72 .number = NFS_PROGRAM,
73 .nrvers = ARRAY_SIZE(nfs_version),
74 .version = nfs_version,
75 .stats = &nfs_rpcstat,
76 .pipe_dir_name = "/nfs",
79 struct rpc_stat nfs_rpcstat = {
80 .program = &nfs_program
84 #ifdef CONFIG_NFS_V3_ACL
85 static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
86 static struct rpc_version * nfsacl_version[] = {
87 [3] = &nfsacl_version3,
90 struct rpc_program nfsacl_program = {
92 .number = NFS_ACL_PROGRAM,
93 .nrvers = ARRAY_SIZE(nfsacl_version),
94 .version = nfsacl_version,
95 .stats = &nfsacl_rpcstat,
97 #endif /* CONFIG_NFS_V3_ACL */
99 struct nfs_client_initdata {
100 const char *hostname;
101 const struct sockaddr *addr;
103 const struct nfs_rpc_ops *rpc_ops;
108 * Allocate a shared client record
110 * Since these are allocated/deallocated very rarely, we don't
111 * bother putting them in a slab cache...
113 static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
115 struct nfs_client *clp;
116 struct rpc_cred *cred;
119 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
122 clp->rpc_ops = cl_init->rpc_ops;
124 if (cl_init->rpc_ops->version == 4) {
125 err = nfs_callback_up();
128 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
131 atomic_set(&clp->cl_count, 1);
132 clp->cl_cons_state = NFS_CS_INITING;
134 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
135 clp->cl_addrlen = cl_init->addrlen;
137 if (cl_init->hostname) {
139 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
140 if (!clp->cl_hostname)
144 INIT_LIST_HEAD(&clp->cl_superblocks);
145 clp->cl_rpcclient = ERR_PTR(-EINVAL);
147 clp->cl_proto = cl_init->proto;
150 INIT_LIST_HEAD(&clp->cl_delegations);
151 spin_lock_init(&clp->cl_lock);
152 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
153 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
154 clp->cl_boot_time = CURRENT_TIME;
155 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
157 cred = rpc_lookup_machine_cred();
159 clp->cl_machine_cred = cred;
161 nfs_fscache_get_client_cookie(clp);
166 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
174 static void nfs4_shutdown_client(struct nfs_client *clp)
177 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
178 nfs4_kill_renewd(clp);
179 BUG_ON(!RB_EMPTY_ROOT(&clp->cl_state_owners));
180 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
181 nfs_idmap_delete(clp);
183 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
188 * Destroy a shared client record
190 static void nfs_free_client(struct nfs_client *clp)
192 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
194 nfs4_shutdown_client(clp);
196 nfs_fscache_release_client_cookie(clp);
198 /* -EIO all pending I/O */
199 if (!IS_ERR(clp->cl_rpcclient))
200 rpc_shutdown_client(clp->cl_rpcclient);
202 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
205 if (clp->cl_machine_cred != NULL)
206 put_rpccred(clp->cl_machine_cred);
208 kfree(clp->cl_hostname);
211 dprintk("<-- nfs_free_client()\n");
215 * Release a reference to a shared client record
217 void nfs_put_client(struct nfs_client *clp)
222 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
224 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
225 list_del(&clp->cl_share_link);
226 spin_unlock(&nfs_client_lock);
228 BUG_ON(!list_empty(&clp->cl_superblocks));
230 nfs_free_client(clp);
234 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
236 * Test if two ip6 socket addresses refer to the same socket by
237 * comparing relevant fields. The padding bytes specifically, are not
238 * compared. sin6_flowinfo is not compared because it only affects QoS
239 * and sin6_scope_id is only compared if the address is "link local"
240 * because "link local" addresses need only be unique to a specific
241 * link. Conversely, ordinary unicast addresses might have different
244 * The caller should ensure both socket addresses are AF_INET6.
246 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
247 const struct sockaddr *sa2)
249 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
250 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
252 if (ipv6_addr_scope(&sin1->sin6_addr) == IPV6_ADDR_SCOPE_LINKLOCAL &&
253 sin1->sin6_scope_id != sin2->sin6_scope_id)
256 return ipv6_addr_equal(&sin1->sin6_addr, &sin1->sin6_addr);
258 #else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
259 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
260 const struct sockaddr *sa2)
267 * Test if two ip4 socket addresses refer to the same socket, by
268 * comparing relevant fields. The padding bytes specifically, are
271 * The caller should ensure both socket addresses are AF_INET.
273 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr *sa1,
274 const struct sockaddr *sa2)
276 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
277 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
279 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
282 static int nfs_sockaddr_cmp_ip6(const struct sockaddr *sa1,
283 const struct sockaddr *sa2)
285 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
286 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
288 return nfs_sockaddr_match_ipaddr6(sa1, sa2) &&
289 (sin1->sin6_port == sin2->sin6_port);
292 static int nfs_sockaddr_cmp_ip4(const struct sockaddr *sa1,
293 const struct sockaddr *sa2)
295 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
296 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
298 return nfs_sockaddr_match_ipaddr4(sa1, sa2) &&
299 (sin1->sin_port == sin2->sin_port);
303 * Test if two socket addresses represent the same actual socket,
304 * by comparing (only) relevant fields, excluding the port number.
306 static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
307 const struct sockaddr *sa2)
309 if (sa1->sa_family != sa2->sa_family)
312 switch (sa1->sa_family) {
314 return nfs_sockaddr_match_ipaddr4(sa1, sa2);
316 return nfs_sockaddr_match_ipaddr6(sa1, sa2);
322 * Test if two socket addresses represent the same actual socket,
323 * by comparing (only) relevant fields, including the port number.
325 static int nfs_sockaddr_cmp(const struct sockaddr *sa1,
326 const struct sockaddr *sa2)
328 if (sa1->sa_family != sa2->sa_family)
331 switch (sa1->sa_family) {
333 return nfs_sockaddr_cmp_ip4(sa1, sa2);
335 return nfs_sockaddr_cmp_ip6(sa1, sa2);
341 * Find a client by IP address and protocol version
342 * - returns NULL if no such client
344 struct nfs_client *nfs_find_client(const struct sockaddr *addr, u32 nfsversion)
346 struct nfs_client *clp;
348 spin_lock(&nfs_client_lock);
349 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
350 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
352 /* Don't match clients that failed to initialise properly */
353 if (clp->cl_cons_state != NFS_CS_READY)
356 /* Different NFS versions cannot share the same nfs_client */
357 if (clp->rpc_ops->version != nfsversion)
360 /* Match only the IP address, not the port number */
361 if (!nfs_sockaddr_match_ipaddr(addr, clap))
364 atomic_inc(&clp->cl_count);
365 spin_unlock(&nfs_client_lock);
368 spin_unlock(&nfs_client_lock);
373 * Find a client by IP address and protocol version
374 * - returns NULL if no such client
376 struct nfs_client *nfs_find_client_next(struct nfs_client *clp)
378 struct sockaddr *sap = (struct sockaddr *)&clp->cl_addr;
379 u32 nfsvers = clp->rpc_ops->version;
381 spin_lock(&nfs_client_lock);
382 list_for_each_entry_continue(clp, &nfs_client_list, cl_share_link) {
383 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
385 /* Don't match clients that failed to initialise properly */
386 if (clp->cl_cons_state != NFS_CS_READY)
389 /* Different NFS versions cannot share the same nfs_client */
390 if (clp->rpc_ops->version != nfsvers)
393 /* Match only the IP address, not the port number */
394 if (!nfs_sockaddr_match_ipaddr(sap, clap))
397 atomic_inc(&clp->cl_count);
398 spin_unlock(&nfs_client_lock);
401 spin_unlock(&nfs_client_lock);
406 * Find an nfs_client on the list that matches the initialisation data
409 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
411 struct nfs_client *clp;
412 const struct sockaddr *sap = data->addr;
414 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
415 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
416 /* Don't match clients that failed to initialise properly */
417 if (clp->cl_cons_state < 0)
420 /* Different NFS versions cannot share the same nfs_client */
421 if (clp->rpc_ops != data->rpc_ops)
424 if (clp->cl_proto != data->proto)
427 /* Match the full socket address */
428 if (!nfs_sockaddr_cmp(sap, clap))
431 atomic_inc(&clp->cl_count);
438 * Look up a client by IP address and protocol version
439 * - creates a new record if one doesn't yet exist
441 static struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
443 struct nfs_client *clp, *new = NULL;
446 dprintk("--> nfs_get_client(%s,v%u)\n",
447 cl_init->hostname ?: "", cl_init->rpc_ops->version);
449 /* see if the client already exists */
451 spin_lock(&nfs_client_lock);
453 clp = nfs_match_client(cl_init);
459 spin_unlock(&nfs_client_lock);
461 new = nfs_alloc_client(cl_init);
462 } while (!IS_ERR(new));
464 dprintk("--> nfs_get_client() = %ld [failed]\n", PTR_ERR(new));
467 /* install a new client and return with it unready */
470 list_add(&clp->cl_share_link, &nfs_client_list);
471 spin_unlock(&nfs_client_lock);
472 dprintk("--> nfs_get_client() = %p [new]\n", clp);
475 /* found an existing client
476 * - make sure it's ready before returning
479 spin_unlock(&nfs_client_lock);
482 nfs_free_client(new);
484 error = wait_event_killable(nfs_client_active_wq,
485 clp->cl_cons_state != NFS_CS_INITING);
488 return ERR_PTR(-ERESTARTSYS);
491 if (clp->cl_cons_state < NFS_CS_READY) {
492 error = clp->cl_cons_state;
494 return ERR_PTR(error);
497 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
499 dprintk("--> nfs_get_client() = %p [share]\n", clp);
504 * Mark a server as ready or failed
506 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
508 clp->cl_cons_state = state;
509 wake_up_all(&nfs_client_active_wq);
513 * Initialise the timeout values for a connection
515 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
516 unsigned int timeo, unsigned int retrans)
518 to->to_initval = timeo * HZ / 10;
519 to->to_retries = retrans;
522 case XPRT_TRANSPORT_TCP:
523 case XPRT_TRANSPORT_RDMA:
524 if (to->to_retries == 0)
525 to->to_retries = NFS_DEF_TCP_RETRANS;
526 if (to->to_initval == 0)
527 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
528 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
529 to->to_initval = NFS_MAX_TCP_TIMEOUT;
530 to->to_increment = to->to_initval;
531 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
532 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
533 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
534 if (to->to_maxval < to->to_initval)
535 to->to_maxval = to->to_initval;
536 to->to_exponential = 0;
538 case XPRT_TRANSPORT_UDP:
539 if (to->to_retries == 0)
540 to->to_retries = NFS_DEF_UDP_RETRANS;
542 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
543 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
544 to->to_initval = NFS_MAX_UDP_TIMEOUT;
545 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
546 to->to_exponential = 1;
554 * Create an RPC client handle
556 static int nfs_create_rpc_client(struct nfs_client *clp,
557 const struct rpc_timeout *timeparms,
558 rpc_authflavor_t flavor,
559 int discrtry, int noresvport)
561 struct rpc_clnt *clnt = NULL;
562 struct rpc_create_args args = {
563 .protocol = clp->cl_proto,
564 .address = (struct sockaddr *)&clp->cl_addr,
565 .addrsize = clp->cl_addrlen,
566 .timeout = timeparms,
567 .servername = clp->cl_hostname,
568 .program = &nfs_program,
569 .version = clp->rpc_ops->version,
570 .authflavor = flavor,
574 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
576 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
578 if (!IS_ERR(clp->cl_rpcclient))
581 clnt = rpc_create(&args);
583 dprintk("%s: cannot create RPC client. Error = %ld\n",
584 __func__, PTR_ERR(clnt));
585 return PTR_ERR(clnt);
588 clp->cl_rpcclient = clnt;
593 * Version 2 or 3 client destruction
595 static void nfs_destroy_server(struct nfs_server *server)
597 if (!(server->flags & NFS_MOUNT_NONLM))
598 nlmclnt_done(server->nlm_host);
602 * Version 2 or 3 lockd setup
604 static int nfs_start_lockd(struct nfs_server *server)
606 struct nlm_host *host;
607 struct nfs_client *clp = server->nfs_client;
608 struct nlmclnt_initdata nlm_init = {
609 .hostname = clp->cl_hostname,
610 .address = (struct sockaddr *)&clp->cl_addr,
611 .addrlen = clp->cl_addrlen,
612 .protocol = server->flags & NFS_MOUNT_TCP ?
613 IPPROTO_TCP : IPPROTO_UDP,
614 .nfs_version = clp->rpc_ops->version,
615 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
619 if (nlm_init.nfs_version > 3)
621 if (server->flags & NFS_MOUNT_NONLM)
624 host = nlmclnt_init(&nlm_init);
626 return PTR_ERR(host);
628 server->nlm_host = host;
629 server->destroy = nfs_destroy_server;
634 * Initialise an NFSv3 ACL client connection
636 #ifdef CONFIG_NFS_V3_ACL
637 static void nfs_init_server_aclclient(struct nfs_server *server)
639 if (server->nfs_client->rpc_ops->version != 3)
641 if (server->flags & NFS_MOUNT_NOACL)
644 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
645 if (IS_ERR(server->client_acl))
648 /* No errors! Assume that Sun nfsacls are supported */
649 server->caps |= NFS_CAP_ACLS;
653 server->caps &= ~NFS_CAP_ACLS;
656 static inline void nfs_init_server_aclclient(struct nfs_server *server)
658 server->flags &= ~NFS_MOUNT_NOACL;
659 server->caps &= ~NFS_CAP_ACLS;
664 * Create a general RPC client
666 static int nfs_init_server_rpcclient(struct nfs_server *server,
667 const struct rpc_timeout *timeo,
668 rpc_authflavor_t pseudoflavour)
670 struct nfs_client *clp = server->nfs_client;
672 server->client = rpc_clone_client(clp->cl_rpcclient);
673 if (IS_ERR(server->client)) {
674 dprintk("%s: couldn't create rpc_client!\n", __func__);
675 return PTR_ERR(server->client);
678 memcpy(&server->client->cl_timeout_default,
680 sizeof(server->client->cl_timeout_default));
681 server->client->cl_timeout = &server->client->cl_timeout_default;
683 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
684 struct rpc_auth *auth;
686 auth = rpcauth_create(pseudoflavour, server->client);
688 dprintk("%s: couldn't create credcache!\n", __func__);
689 return PTR_ERR(auth);
692 server->client->cl_softrtry = 0;
693 if (server->flags & NFS_MOUNT_SOFT)
694 server->client->cl_softrtry = 1;
700 * Initialise an NFS2 or NFS3 client
702 static int nfs_init_client(struct nfs_client *clp,
703 const struct rpc_timeout *timeparms,
704 const struct nfs_parsed_mount_data *data)
708 if (clp->cl_cons_state == NFS_CS_READY) {
709 /* the client is already initialised */
710 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
715 * Create a client RPC handle for doing FSSTAT with UNIX auth only
716 * - RFC 2623, sec 2.3.2
718 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX,
719 0, data->flags & NFS_MOUNT_NORESVPORT);
722 nfs_mark_client_ready(clp, NFS_CS_READY);
726 nfs_mark_client_ready(clp, error);
727 dprintk("<-- nfs_init_client() = xerror %d\n", error);
732 * Create a version 2 or 3 client
734 static int nfs_init_server(struct nfs_server *server,
735 const struct nfs_parsed_mount_data *data)
737 struct nfs_client_initdata cl_init = {
738 .hostname = data->nfs_server.hostname,
739 .addr = (const struct sockaddr *)&data->nfs_server.address,
740 .addrlen = data->nfs_server.addrlen,
741 .rpc_ops = &nfs_v2_clientops,
742 .proto = data->nfs_server.protocol,
744 struct rpc_timeout timeparms;
745 struct nfs_client *clp;
748 dprintk("--> nfs_init_server()\n");
751 if (data->flags & NFS_MOUNT_VER3)
752 cl_init.rpc_ops = &nfs_v3_clientops;
755 /* Allocate or find a client reference we can use */
756 clp = nfs_get_client(&cl_init);
758 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
762 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
763 data->timeo, data->retrans);
764 error = nfs_init_client(clp, &timeparms, data);
768 server->nfs_client = clp;
770 /* Initialise the client representation from the mount data */
771 server->flags = data->flags;
772 server->options = data->options;
775 server->rsize = nfs_block_size(data->rsize, NULL);
777 server->wsize = nfs_block_size(data->wsize, NULL);
779 server->acregmin = data->acregmin * HZ;
780 server->acregmax = data->acregmax * HZ;
781 server->acdirmin = data->acdirmin * HZ;
782 server->acdirmax = data->acdirmax * HZ;
784 /* Start lockd here, before we might error out */
785 error = nfs_start_lockd(server);
789 server->port = data->nfs_server.port;
791 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
795 /* Preserve the values of mount_server-related mount options */
796 if (data->mount_server.addrlen) {
797 memcpy(&server->mountd_address, &data->mount_server.address,
798 data->mount_server.addrlen);
799 server->mountd_addrlen = data->mount_server.addrlen;
801 server->mountd_version = data->mount_server.version;
802 server->mountd_port = data->mount_server.port;
803 server->mountd_protocol = data->mount_server.protocol;
805 server->namelen = data->namlen;
806 /* Create a client RPC handle for the NFSv3 ACL management interface */
807 nfs_init_server_aclclient(server);
808 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
812 server->nfs_client = NULL;
814 dprintk("<-- nfs_init_server() = xerror %d\n", error);
819 * Load up the server record from information gained in an fsinfo record
821 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
823 unsigned long max_rpc_payload;
825 /* Work out a lot of parameters */
826 if (server->rsize == 0)
827 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
828 if (server->wsize == 0)
829 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
831 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
832 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
833 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
834 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
836 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
837 if (server->rsize > max_rpc_payload)
838 server->rsize = max_rpc_payload;
839 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
840 server->rsize = NFS_MAX_FILE_IO_SIZE;
841 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
843 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
845 if (server->wsize > max_rpc_payload)
846 server->wsize = max_rpc_payload;
847 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
848 server->wsize = NFS_MAX_FILE_IO_SIZE;
849 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
850 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
852 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
853 if (server->dtsize > PAGE_CACHE_SIZE)
854 server->dtsize = PAGE_CACHE_SIZE;
855 if (server->dtsize > server->rsize)
856 server->dtsize = server->rsize;
858 if (server->flags & NFS_MOUNT_NOAC) {
859 server->acregmin = server->acregmax = 0;
860 server->acdirmin = server->acdirmax = 0;
863 server->maxfilesize = fsinfo->maxfilesize;
865 /* We're airborne Set socket buffersize */
866 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
870 * Probe filesystem information, including the FSID on v2/v3
872 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
874 struct nfs_fsinfo fsinfo;
875 struct nfs_client *clp = server->nfs_client;
878 dprintk("--> nfs_probe_fsinfo()\n");
880 if (clp->rpc_ops->set_capabilities != NULL) {
881 error = clp->rpc_ops->set_capabilities(server, mntfh);
886 fsinfo.fattr = fattr;
887 nfs_fattr_init(fattr);
888 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
892 nfs_server_set_fsinfo(server, &fsinfo);
893 error = bdi_init(&server->backing_dev_info);
898 /* Get some general file system info */
899 if (server->namelen == 0) {
900 struct nfs_pathconf pathinfo;
902 pathinfo.fattr = fattr;
903 nfs_fattr_init(fattr);
905 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
906 server->namelen = pathinfo.max_namelen;
909 dprintk("<-- nfs_probe_fsinfo() = 0\n");
913 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
918 * Copy useful information when duplicating a server record
920 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
922 target->flags = source->flags;
923 target->acregmin = source->acregmin;
924 target->acregmax = source->acregmax;
925 target->acdirmin = source->acdirmin;
926 target->acdirmax = source->acdirmax;
927 target->caps = source->caps;
931 * Allocate and initialise a server record
933 static struct nfs_server *nfs_alloc_server(void)
935 struct nfs_server *server;
937 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
941 server->client = server->client_acl = ERR_PTR(-EINVAL);
943 /* Zero out the NFS state stuff */
944 INIT_LIST_HEAD(&server->client_link);
945 INIT_LIST_HEAD(&server->master_link);
947 atomic_set(&server->active, 0);
949 server->io_stats = nfs_alloc_iostats();
950 if (!server->io_stats) {
959 * Free up a server record
961 void nfs_free_server(struct nfs_server *server)
963 dprintk("--> nfs_free_server()\n");
965 spin_lock(&nfs_client_lock);
966 list_del(&server->client_link);
967 list_del(&server->master_link);
968 spin_unlock(&nfs_client_lock);
970 if (server->destroy != NULL)
971 server->destroy(server);
973 if (!IS_ERR(server->client_acl))
974 rpc_shutdown_client(server->client_acl);
975 if (!IS_ERR(server->client))
976 rpc_shutdown_client(server->client);
978 nfs_put_client(server->nfs_client);
980 nfs_free_iostats(server->io_stats);
981 bdi_destroy(&server->backing_dev_info);
983 nfs_release_automount_timer();
984 dprintk("<-- nfs_free_server()\n");
988 * Create a version 2 or 3 volume record
989 * - keyed on server and FSID
991 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
992 struct nfs_fh *mntfh)
994 struct nfs_server *server;
995 struct nfs_fattr fattr;
998 server = nfs_alloc_server();
1000 return ERR_PTR(-ENOMEM);
1002 /* Get a client representation */
1003 error = nfs_init_server(server, data);
1007 BUG_ON(!server->nfs_client);
1008 BUG_ON(!server->nfs_client->rpc_ops);
1009 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1011 /* Probe the root fh to retrieve its FSID */
1012 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1015 if (server->nfs_client->rpc_ops->version == 3) {
1016 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1017 server->namelen = NFS3_MAXNAMLEN;
1018 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
1019 server->caps |= NFS_CAP_READDIRPLUS;
1021 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1022 server->namelen = NFS2_MAXNAMLEN;
1025 if (!(fattr.valid & NFS_ATTR_FATTR)) {
1026 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
1028 dprintk("nfs_create_server: getattr error = %d\n", -error);
1032 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
1034 dprintk("Server FSID: %llx:%llx\n",
1035 (unsigned long long) server->fsid.major,
1036 (unsigned long long) server->fsid.minor);
1038 BUG_ON(!server->nfs_client);
1039 BUG_ON(!server->nfs_client->rpc_ops);
1040 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1042 spin_lock(&nfs_client_lock);
1043 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1044 list_add_tail(&server->master_link, &nfs_volume_list);
1045 spin_unlock(&nfs_client_lock);
1047 server->mount_time = jiffies;
1051 nfs_free_server(server);
1052 return ERR_PTR(error);
1055 #ifdef CONFIG_NFS_V4
1057 * Initialise an NFS4 client record
1059 static int nfs4_init_client(struct nfs_client *clp,
1060 const struct rpc_timeout *timeparms,
1061 const char *ip_addr,
1062 rpc_authflavor_t authflavour,
1067 if (clp->cl_cons_state == NFS_CS_READY) {
1068 /* the client is initialised already */
1069 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
1073 /* Check NFS protocol revision and initialize RPC op vector */
1074 clp->rpc_ops = &nfs_v4_clientops;
1076 error = nfs_create_rpc_client(clp, timeparms, authflavour,
1077 1, flags & NFS_MOUNT_NORESVPORT);
1080 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
1082 error = nfs_idmap_new(clp);
1084 dprintk("%s: failed to create idmapper. Error = %d\n",
1088 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
1090 nfs_mark_client_ready(clp, NFS_CS_READY);
1094 nfs_mark_client_ready(clp, error);
1095 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
1100 * Set up an NFS4 client
1102 static int nfs4_set_client(struct nfs_server *server,
1103 const char *hostname,
1104 const struct sockaddr *addr,
1105 const size_t addrlen,
1106 const char *ip_addr,
1107 rpc_authflavor_t authflavour,
1108 int proto, const struct rpc_timeout *timeparms)
1110 struct nfs_client_initdata cl_init = {
1111 .hostname = hostname,
1114 .rpc_ops = &nfs_v4_clientops,
1117 struct nfs_client *clp;
1120 dprintk("--> nfs4_set_client()\n");
1122 /* Allocate or find a client reference we can use */
1123 clp = nfs_get_client(&cl_init);
1125 error = PTR_ERR(clp);
1128 error = nfs4_init_client(clp, timeparms, ip_addr, authflavour,
1133 server->nfs_client = clp;
1134 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
1138 nfs_put_client(clp);
1140 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
1145 * Create a version 4 volume record
1147 static int nfs4_init_server(struct nfs_server *server,
1148 const struct nfs_parsed_mount_data *data)
1150 struct rpc_timeout timeparms;
1153 dprintk("--> nfs4_init_server()\n");
1155 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1156 data->timeo, data->retrans);
1158 /* Initialise the client representation from the mount data */
1159 server->flags = data->flags;
1160 server->caps |= NFS_CAP_ATOMIC_OPEN;
1161 server->options = data->options;
1163 /* Get a client record */
1164 error = nfs4_set_client(server,
1165 data->nfs_server.hostname,
1166 (const struct sockaddr *)&data->nfs_server.address,
1167 data->nfs_server.addrlen,
1168 data->client_address,
1169 data->auth_flavors[0],
1170 data->nfs_server.protocol,
1176 server->rsize = nfs_block_size(data->rsize, NULL);
1178 server->wsize = nfs_block_size(data->wsize, NULL);
1180 server->acregmin = data->acregmin * HZ;
1181 server->acregmax = data->acregmax * HZ;
1182 server->acdirmin = data->acdirmin * HZ;
1183 server->acdirmax = data->acdirmax * HZ;
1185 server->port = data->nfs_server.port;
1187 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1191 dprintk("<-- nfs4_init_server() = %d\n", error);
1196 * Create a version 4 volume record
1197 * - keyed on server and FSID
1199 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1200 struct nfs_fh *mntfh)
1202 struct nfs_fattr fattr;
1203 struct nfs_server *server;
1206 dprintk("--> nfs4_create_server()\n");
1208 server = nfs_alloc_server();
1210 return ERR_PTR(-ENOMEM);
1212 /* set up the general RPC client */
1213 error = nfs4_init_server(server, data);
1217 BUG_ON(!server->nfs_client);
1218 BUG_ON(!server->nfs_client->rpc_ops);
1219 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1221 /* Probe the root fh to retrieve its FSID */
1222 error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
1226 dprintk("Server FSID: %llx:%llx\n",
1227 (unsigned long long) server->fsid.major,
1228 (unsigned long long) server->fsid.minor);
1229 dprintk("Mount FH: %d\n", mntfh->size);
1231 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1235 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1236 server->namelen = NFS4_MAXNAMLEN;
1238 BUG_ON(!server->nfs_client);
1239 BUG_ON(!server->nfs_client->rpc_ops);
1240 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1242 spin_lock(&nfs_client_lock);
1243 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1244 list_add_tail(&server->master_link, &nfs_volume_list);
1245 spin_unlock(&nfs_client_lock);
1247 server->mount_time = jiffies;
1248 dprintk("<-- nfs4_create_server() = %p\n", server);
1252 nfs_free_server(server);
1253 dprintk("<-- nfs4_create_server() = error %d\n", error);
1254 return ERR_PTR(error);
1258 * Create an NFS4 referral server record
1260 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1261 struct nfs_fh *mntfh)
1263 struct nfs_client *parent_client;
1264 struct nfs_server *server, *parent_server;
1265 struct nfs_fattr fattr;
1268 dprintk("--> nfs4_create_referral_server()\n");
1270 server = nfs_alloc_server();
1272 return ERR_PTR(-ENOMEM);
1274 parent_server = NFS_SB(data->sb);
1275 parent_client = parent_server->nfs_client;
1277 /* Initialise the client representation from the parent server */
1278 nfs_server_copy_userdata(server, parent_server);
1279 server->caps |= NFS_CAP_ATOMIC_OPEN;
1281 /* Get a client representation.
1282 * Note: NFSv4 always uses TCP, */
1283 error = nfs4_set_client(server, data->hostname,
1286 parent_client->cl_ipaddr,
1288 parent_server->client->cl_xprt->prot,
1289 parent_server->client->cl_timeout);
1293 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1297 BUG_ON(!server->nfs_client);
1298 BUG_ON(!server->nfs_client->rpc_ops);
1299 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1301 /* Probe the root fh to retrieve its FSID and filehandle */
1302 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1306 /* probe the filesystem info for this server filesystem */
1307 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1311 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1312 server->namelen = NFS4_MAXNAMLEN;
1314 dprintk("Referral FSID: %llx:%llx\n",
1315 (unsigned long long) server->fsid.major,
1316 (unsigned long long) server->fsid.minor);
1318 spin_lock(&nfs_client_lock);
1319 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1320 list_add_tail(&server->master_link, &nfs_volume_list);
1321 spin_unlock(&nfs_client_lock);
1323 server->mount_time = jiffies;
1325 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1329 nfs_free_server(server);
1330 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1331 return ERR_PTR(error);
1334 #endif /* CONFIG_NFS_V4 */
1337 * Clone an NFS2, NFS3 or NFS4 server record
1339 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1341 struct nfs_fattr *fattr)
1343 struct nfs_server *server;
1344 struct nfs_fattr fattr_fsinfo;
1347 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1348 (unsigned long long) fattr->fsid.major,
1349 (unsigned long long) fattr->fsid.minor);
1351 server = nfs_alloc_server();
1353 return ERR_PTR(-ENOMEM);
1355 /* Copy data from the source */
1356 server->nfs_client = source->nfs_client;
1357 atomic_inc(&server->nfs_client->cl_count);
1358 nfs_server_copy_userdata(server, source);
1360 server->fsid = fattr->fsid;
1362 error = nfs_init_server_rpcclient(server,
1363 source->client->cl_timeout,
1364 source->client->cl_auth->au_flavor);
1366 goto out_free_server;
1367 if (!IS_ERR(source->client_acl))
1368 nfs_init_server_aclclient(server);
1370 /* probe the filesystem info for this server filesystem */
1371 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1373 goto out_free_server;
1375 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1376 server->namelen = NFS4_MAXNAMLEN;
1378 dprintk("Cloned FSID: %llx:%llx\n",
1379 (unsigned long long) server->fsid.major,
1380 (unsigned long long) server->fsid.minor);
1382 error = nfs_start_lockd(server);
1384 goto out_free_server;
1386 spin_lock(&nfs_client_lock);
1387 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1388 list_add_tail(&server->master_link, &nfs_volume_list);
1389 spin_unlock(&nfs_client_lock);
1391 server->mount_time = jiffies;
1393 dprintk("<-- nfs_clone_server() = %p\n", server);
1397 nfs_free_server(server);
1398 dprintk("<-- nfs_clone_server() = error %d\n", error);
1399 return ERR_PTR(error);
1402 #ifdef CONFIG_PROC_FS
1403 static struct proc_dir_entry *proc_fs_nfs;
1405 static int nfs_server_list_open(struct inode *inode, struct file *file);
1406 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1407 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1408 static void nfs_server_list_stop(struct seq_file *p, void *v);
1409 static int nfs_server_list_show(struct seq_file *m, void *v);
1411 static struct seq_operations nfs_server_list_ops = {
1412 .start = nfs_server_list_start,
1413 .next = nfs_server_list_next,
1414 .stop = nfs_server_list_stop,
1415 .show = nfs_server_list_show,
1418 static const struct file_operations nfs_server_list_fops = {
1419 .open = nfs_server_list_open,
1421 .llseek = seq_lseek,
1422 .release = seq_release,
1423 .owner = THIS_MODULE,
1426 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1427 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1428 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1429 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1430 static int nfs_volume_list_show(struct seq_file *m, void *v);
1432 static struct seq_operations nfs_volume_list_ops = {
1433 .start = nfs_volume_list_start,
1434 .next = nfs_volume_list_next,
1435 .stop = nfs_volume_list_stop,
1436 .show = nfs_volume_list_show,
1439 static const struct file_operations nfs_volume_list_fops = {
1440 .open = nfs_volume_list_open,
1442 .llseek = seq_lseek,
1443 .release = seq_release,
1444 .owner = THIS_MODULE,
1448 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1451 static int nfs_server_list_open(struct inode *inode, struct file *file)
1456 ret = seq_open(file, &nfs_server_list_ops);
1460 m = file->private_data;
1461 m->private = PDE(inode)->data;
1467 * set up the iterator to start reading from the server list and return the first item
1469 static void *nfs_server_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_client_list, *_pos);
1477 * move to next server
1479 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1481 return seq_list_next(v, &nfs_client_list, pos);
1485 * clean up after reading from the transports list
1487 static void nfs_server_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_server_list_show(struct seq_file *m, void *v)
1497 struct nfs_client *clp;
1499 /* display header on line 1 */
1500 if (v == &nfs_client_list) {
1501 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1505 /* display one transport per line on subsequent lines */
1506 clp = list_entry(v, struct nfs_client, cl_share_link);
1508 seq_printf(m, "v%u %s %s %3d %s\n",
1509 clp->rpc_ops->version,
1510 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1511 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1512 atomic_read(&clp->cl_count),
1519 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1521 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1526 ret = seq_open(file, &nfs_volume_list_ops);
1530 m = file->private_data;
1531 m->private = PDE(inode)->data;
1537 * set up the iterator to start reading from the volume list and return the first item
1539 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1541 /* lock the list against modification */
1542 spin_lock(&nfs_client_lock);
1543 return seq_list_start_head(&nfs_volume_list, *_pos);
1547 * move to next volume
1549 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1551 return seq_list_next(v, &nfs_volume_list, pos);
1555 * clean up after reading from the transports list
1557 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1559 spin_unlock(&nfs_client_lock);
1563 * display a header line followed by a load of call lines
1565 static int nfs_volume_list_show(struct seq_file *m, void *v)
1567 struct nfs_server *server;
1568 struct nfs_client *clp;
1569 char dev[8], fsid[17];
1571 /* display header on line 1 */
1572 if (v == &nfs_volume_list) {
1573 seq_puts(m, "NV SERVER PORT DEV FSID FSC\n");
1576 /* display one transport per line on subsequent lines */
1577 server = list_entry(v, struct nfs_server, master_link);
1578 clp = server->nfs_client;
1580 snprintf(dev, 8, "%u:%u",
1581 MAJOR(server->s_dev), MINOR(server->s_dev));
1583 snprintf(fsid, 17, "%llx:%llx",
1584 (unsigned long long) server->fsid.major,
1585 (unsigned long long) server->fsid.minor);
1587 seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
1588 clp->rpc_ops->version,
1589 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1590 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1593 nfs_server_fscache_state(server));
1599 * initialise the /proc/fs/nfsfs/ directory
1601 int __init nfs_fs_proc_init(void)
1603 struct proc_dir_entry *p;
1605 proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1609 /* a file of servers with which we're dealing */
1610 p = proc_create("servers", S_IFREG|S_IRUGO,
1611 proc_fs_nfs, &nfs_server_list_fops);
1615 /* a file of volumes that we have mounted */
1616 p = proc_create("volumes", S_IFREG|S_IRUGO,
1617 proc_fs_nfs, &nfs_volume_list_fops);
1623 remove_proc_entry("servers", proc_fs_nfs);
1625 remove_proc_entry("fs/nfsfs", NULL);
1631 * clean up the /proc/fs/nfsfs/ directory
1633 void nfs_fs_proc_exit(void)
1635 remove_proc_entry("volumes", proc_fs_nfs);
1636 remove_proc_entry("servers", proc_fs_nfs);
1637 remove_proc_entry("fs/nfsfs", NULL);
1640 #endif /* CONFIG_PROC_FS */