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>
38 #include <linux/slab.h>
39 #include <linux/idr.h>
41 #include <linux/nfs_xdr.h>
42 #include <linux/sunrpc/bc_xprt.h>
43 #include <linux/nsproxy.h>
44 #include <linux/pid_namespace.h>
49 #include "delegation.h"
57 #define NFSDBG_FACILITY NFSDBG_CLIENT
59 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
60 static DEFINE_SPINLOCK(nfs_version_lock);
61 static DEFINE_MUTEX(nfs_version_mutex);
62 static LIST_HEAD(nfs_versions);
67 static const struct rpc_version *nfs_version[5] = {
73 const struct rpc_program nfs_program = {
75 .number = NFS_PROGRAM,
76 .nrvers = ARRAY_SIZE(nfs_version),
77 .version = nfs_version,
78 .stats = &nfs_rpcstat,
79 .pipe_dir_name = NFS_PIPE_DIRNAME,
82 struct rpc_stat nfs_rpcstat = {
83 .program = &nfs_program
86 static struct nfs_subversion *find_nfs_version(unsigned int version)
88 struct nfs_subversion *nfs;
89 spin_lock(&nfs_version_lock);
91 list_for_each_entry(nfs, &nfs_versions, list) {
92 if (nfs->rpc_ops->version == version) {
93 spin_unlock(&nfs_version_lock);
98 spin_unlock(&nfs_version_lock);
99 return ERR_PTR(-EPROTONOSUPPORT);
102 struct nfs_subversion *get_nfs_version(unsigned int version)
104 struct nfs_subversion *nfs = find_nfs_version(version);
107 mutex_lock(&nfs_version_mutex);
108 request_module("nfsv%d", version);
109 nfs = find_nfs_version(version);
110 mutex_unlock(&nfs_version_mutex);
114 try_module_get(nfs->owner);
118 void put_nfs_version(struct nfs_subversion *nfs)
120 module_put(nfs->owner);
123 void register_nfs_version(struct nfs_subversion *nfs)
125 spin_lock(&nfs_version_lock);
127 list_add(&nfs->list, &nfs_versions);
128 nfs_version[nfs->rpc_ops->version] = nfs->rpc_vers;
130 spin_unlock(&nfs_version_lock);
132 EXPORT_SYMBOL_GPL(register_nfs_version);
134 void unregister_nfs_version(struct nfs_subversion *nfs)
136 spin_lock(&nfs_version_lock);
138 nfs_version[nfs->rpc_ops->version] = NULL;
139 list_del(&nfs->list);
141 spin_unlock(&nfs_version_lock);
143 EXPORT_SYMBOL_GPL(unregister_nfs_version);
146 * Allocate a shared client record
148 * Since these are allocated/deallocated very rarely, we don't
149 * bother putting them in a slab cache...
151 struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
153 struct nfs_client *clp;
154 struct rpc_cred *cred;
157 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
160 clp->cl_nfs_mod = cl_init->nfs_mod;
161 try_module_get(clp->cl_nfs_mod->owner);
163 clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
165 atomic_set(&clp->cl_count, 1);
166 clp->cl_cons_state = NFS_CS_INITING;
168 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
169 clp->cl_addrlen = cl_init->addrlen;
171 if (cl_init->hostname) {
173 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
174 if (!clp->cl_hostname)
178 INIT_LIST_HEAD(&clp->cl_superblocks);
179 clp->cl_rpcclient = ERR_PTR(-EINVAL);
181 clp->cl_proto = cl_init->proto;
182 clp->cl_net = get_net(cl_init->net);
184 cred = rpc_lookup_machine_cred("*");
186 clp->cl_machine_cred = cred;
187 nfs_fscache_get_client_cookie(clp);
192 put_nfs_version(clp->cl_nfs_mod);
197 EXPORT_SYMBOL_GPL(nfs_alloc_client);
199 #if IS_ENABLED(CONFIG_NFS_V4)
200 void nfs_cleanup_cb_ident_idr(struct net *net)
202 struct nfs_net *nn = net_generic(net, nfs_net_id);
204 idr_destroy(&nn->cb_ident_idr);
207 /* nfs_client_lock held */
208 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
210 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
212 if (clp->cl_cb_ident)
213 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
216 static void pnfs_init_server(struct nfs_server *server)
218 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
222 void nfs_cleanup_cb_ident_idr(struct net *net)
226 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
230 static void pnfs_init_server(struct nfs_server *server)
234 #endif /* CONFIG_NFS_V4 */
237 * Destroy a shared client record
239 void nfs_free_client(struct nfs_client *clp)
241 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
243 nfs_fscache_release_client_cookie(clp);
245 /* -EIO all pending I/O */
246 if (!IS_ERR(clp->cl_rpcclient))
247 rpc_shutdown_client(clp->cl_rpcclient);
249 if (clp->cl_machine_cred != NULL)
250 put_rpccred(clp->cl_machine_cred);
252 put_net(clp->cl_net);
253 put_nfs_version(clp->cl_nfs_mod);
254 kfree(clp->cl_hostname);
255 kfree(clp->cl_acceptor);
258 dprintk("<-- nfs_free_client()\n");
260 EXPORT_SYMBOL_GPL(nfs_free_client);
263 * Release a reference to a shared client record
265 void nfs_put_client(struct nfs_client *clp)
272 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
273 nn = net_generic(clp->cl_net, nfs_net_id);
275 if (atomic_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
276 list_del(&clp->cl_share_link);
277 nfs_cb_idr_remove_locked(clp);
278 spin_unlock(&nn->nfs_client_lock);
280 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
282 clp->rpc_ops->free_client(clp);
285 EXPORT_SYMBOL_GPL(nfs_put_client);
287 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
289 * Test if two ip6 socket addresses refer to the same socket by
290 * comparing relevant fields. The padding bytes specifically, are not
291 * compared. sin6_flowinfo is not compared because it only affects QoS
292 * and sin6_scope_id is only compared if the address is "link local"
293 * because "link local" addresses need only be unique to a specific
294 * link. Conversely, ordinary unicast addresses might have different
297 * The caller should ensure both socket addresses are AF_INET6.
299 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
300 const struct sockaddr *sa2)
302 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
303 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
305 if (!ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr))
307 else if (ipv6_addr_type(&sin1->sin6_addr) & IPV6_ADDR_LINKLOCAL)
308 return sin1->sin6_scope_id == sin2->sin6_scope_id;
312 #else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
313 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
314 const struct sockaddr *sa2)
321 * Test if two ip4 socket addresses refer to the same socket, by
322 * comparing relevant fields. The padding bytes specifically, are
325 * The caller should ensure both socket addresses are AF_INET.
327 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr *sa1,
328 const struct sockaddr *sa2)
330 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
331 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
333 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
336 static int nfs_sockaddr_cmp_ip6(const struct sockaddr *sa1,
337 const struct sockaddr *sa2)
339 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
340 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
342 return nfs_sockaddr_match_ipaddr6(sa1, sa2) &&
343 (sin1->sin6_port == sin2->sin6_port);
346 static int nfs_sockaddr_cmp_ip4(const struct sockaddr *sa1,
347 const struct sockaddr *sa2)
349 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
350 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
352 return nfs_sockaddr_match_ipaddr4(sa1, sa2) &&
353 (sin1->sin_port == sin2->sin_port);
356 #if defined(CONFIG_NFS_V4_1)
358 * Test if two socket addresses represent the same actual socket,
359 * by comparing (only) relevant fields, excluding the port number.
361 int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
362 const struct sockaddr *sa2)
364 if (sa1->sa_family != sa2->sa_family)
367 switch (sa1->sa_family) {
369 return nfs_sockaddr_match_ipaddr4(sa1, sa2);
371 return nfs_sockaddr_match_ipaddr6(sa1, sa2);
375 EXPORT_SYMBOL_GPL(nfs_sockaddr_match_ipaddr);
376 #endif /* CONFIG_NFS_V4_1 */
379 * Test if two socket addresses represent the same actual socket,
380 * by comparing (only) relevant fields, including the port number.
382 static int nfs_sockaddr_cmp(const struct sockaddr *sa1,
383 const struct sockaddr *sa2)
385 if (sa1->sa_family != sa2->sa_family)
388 switch (sa1->sa_family) {
390 return nfs_sockaddr_cmp_ip4(sa1, sa2);
392 return nfs_sockaddr_cmp_ip6(sa1, sa2);
398 * Find an nfs_client on the list that matches the initialisation data
401 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
403 struct nfs_client *clp;
404 const struct sockaddr *sap = data->addr;
405 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
407 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
408 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
409 /* Don't match clients that failed to initialise properly */
410 if (clp->cl_cons_state < 0)
413 /* Different NFS versions cannot share the same nfs_client */
414 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
417 if (clp->cl_proto != data->proto)
419 /* Match nfsv4 minorversion */
420 if (clp->cl_minorversion != data->minorversion)
422 /* Match the full socket address */
423 if (!nfs_sockaddr_cmp(sap, clap))
426 atomic_inc(&clp->cl_count);
432 static bool nfs_client_init_is_complete(const struct nfs_client *clp)
434 return clp->cl_cons_state != NFS_CS_INITING;
437 int nfs_wait_client_init_complete(const struct nfs_client *clp)
439 return wait_event_killable(nfs_client_active_wq,
440 nfs_client_init_is_complete(clp));
442 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
445 * Found an existing client. Make sure it's ready before returning.
447 static struct nfs_client *
448 nfs_found_client(const struct nfs_client_initdata *cl_init,
449 struct nfs_client *clp)
453 error = nfs_wait_client_init_complete(clp);
456 return ERR_PTR(-ERESTARTSYS);
459 if (clp->cl_cons_state < NFS_CS_READY) {
460 error = clp->cl_cons_state;
462 return ERR_PTR(error);
467 dprintk("<-- %s found nfs_client %p for %s\n",
468 __func__, clp, cl_init->hostname ?: "");
473 * Look up a client by IP address and protocol version
474 * - creates a new record if one doesn't yet exist
477 nfs_get_client(const struct nfs_client_initdata *cl_init,
478 const struct rpc_timeout *timeparms,
480 rpc_authflavor_t authflavour)
482 struct nfs_client *clp, *new = NULL;
483 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
484 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
486 if (cl_init->hostname == NULL) {
491 dprintk("--> nfs_get_client(%s,v%u)\n",
492 cl_init->hostname, rpc_ops->version);
494 /* see if the client already exists */
496 spin_lock(&nn->nfs_client_lock);
498 clp = nfs_match_client(cl_init);
500 spin_unlock(&nn->nfs_client_lock);
502 new->rpc_ops->free_client(new);
503 return nfs_found_client(cl_init, clp);
506 list_add_tail(&new->cl_share_link,
507 &nn->nfs_client_list);
508 spin_unlock(&nn->nfs_client_lock);
509 new->cl_flags = cl_init->init_flags;
510 return rpc_ops->init_client(new, timeparms, ip_addr);
513 spin_unlock(&nn->nfs_client_lock);
515 new = rpc_ops->alloc_client(cl_init);
516 } while (!IS_ERR(new));
518 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
519 cl_init->hostname, PTR_ERR(new));
522 EXPORT_SYMBOL_GPL(nfs_get_client);
525 * Mark a server as ready or failed
527 void nfs_mark_client_ready(struct nfs_client *clp, int state)
530 clp->cl_cons_state = state;
531 wake_up_all(&nfs_client_active_wq);
533 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
536 * Initialise the timeout values for a connection
538 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
539 unsigned int timeo, unsigned int retrans)
541 to->to_initval = timeo * HZ / 10;
542 to->to_retries = retrans;
545 case XPRT_TRANSPORT_TCP:
546 case XPRT_TRANSPORT_RDMA:
547 if (to->to_retries == 0)
548 to->to_retries = NFS_DEF_TCP_RETRANS;
549 if (to->to_initval == 0)
550 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
551 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
552 to->to_initval = NFS_MAX_TCP_TIMEOUT;
553 to->to_increment = to->to_initval;
554 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
555 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
556 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
557 if (to->to_maxval < to->to_initval)
558 to->to_maxval = to->to_initval;
559 to->to_exponential = 0;
561 case XPRT_TRANSPORT_UDP:
562 if (to->to_retries == 0)
563 to->to_retries = NFS_DEF_UDP_RETRANS;
565 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
566 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
567 to->to_initval = NFS_MAX_UDP_TIMEOUT;
568 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
569 to->to_exponential = 1;
575 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
578 * Create an RPC client handle
580 int nfs_create_rpc_client(struct nfs_client *clp,
581 const struct rpc_timeout *timeparms,
582 rpc_authflavor_t flavor)
584 struct rpc_clnt *clnt = NULL;
585 struct rpc_create_args args = {
587 .protocol = clp->cl_proto,
588 .address = (struct sockaddr *)&clp->cl_addr,
589 .addrsize = clp->cl_addrlen,
590 .timeout = timeparms,
591 .servername = clp->cl_hostname,
592 .program = &nfs_program,
593 .version = clp->rpc_ops->version,
594 .authflavor = flavor,
597 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
598 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
599 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
600 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
601 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
602 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
603 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
604 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
606 if (!IS_ERR(clp->cl_rpcclient))
609 clnt = rpc_create(&args);
611 dprintk("%s: cannot create RPC client. Error = %ld\n",
612 __func__, PTR_ERR(clnt));
613 return PTR_ERR(clnt);
616 clp->cl_rpcclient = clnt;
619 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
622 * Version 2 or 3 client destruction
624 static void nfs_destroy_server(struct nfs_server *server)
626 if (server->nlm_host)
627 nlmclnt_done(server->nlm_host);
631 * Version 2 or 3 lockd setup
633 static int nfs_start_lockd(struct nfs_server *server)
635 struct nlm_host *host;
636 struct nfs_client *clp = server->nfs_client;
637 struct nlmclnt_initdata nlm_init = {
638 .hostname = clp->cl_hostname,
639 .address = (struct sockaddr *)&clp->cl_addr,
640 .addrlen = clp->cl_addrlen,
641 .nfs_version = clp->rpc_ops->version,
642 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
647 if (nlm_init.nfs_version > 3)
649 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
650 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
653 switch (clp->cl_proto) {
655 nlm_init.protocol = IPPROTO_TCP;
657 case XPRT_TRANSPORT_UDP:
658 nlm_init.protocol = IPPROTO_UDP;
661 host = nlmclnt_init(&nlm_init);
663 return PTR_ERR(host);
665 server->nlm_host = host;
666 server->destroy = nfs_destroy_server;
671 * Create a general RPC client
673 int nfs_init_server_rpcclient(struct nfs_server *server,
674 const struct rpc_timeout *timeo,
675 rpc_authflavor_t pseudoflavour)
677 struct nfs_client *clp = server->nfs_client;
679 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
681 if (IS_ERR(server->client)) {
682 dprintk("%s: couldn't create rpc_client!\n", __func__);
683 return PTR_ERR(server->client);
686 memcpy(&server->client->cl_timeout_default,
688 sizeof(server->client->cl_timeout_default));
689 server->client->cl_timeout = &server->client->cl_timeout_default;
690 server->client->cl_softrtry = 0;
691 if (server->flags & NFS_MOUNT_SOFT)
692 server->client->cl_softrtry = 1;
696 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
699 * nfs_init_client - Initialise an NFS2 or NFS3 client
701 * @clp: nfs_client to initialise
702 * @timeparms: timeout parameters for underlying RPC transport
703 * @ip_addr: IP presentation address (not used)
705 * Returns pointer to an NFS client, or an ERR_PTR value.
707 struct nfs_client *nfs_init_client(struct nfs_client *clp,
708 const struct rpc_timeout *timeparms,
713 if (clp->cl_cons_state == NFS_CS_READY) {
714 /* the client is already initialised */
715 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
720 * Create a client RPC handle for doing FSSTAT with UNIX auth only
721 * - RFC 2623, sec 2.3.2
723 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX);
726 nfs_mark_client_ready(clp, NFS_CS_READY);
730 nfs_mark_client_ready(clp, error);
732 dprintk("<-- nfs_init_client() = xerror %d\n", error);
733 return ERR_PTR(error);
735 EXPORT_SYMBOL_GPL(nfs_init_client);
738 * Create a version 2 or 3 client
740 static int nfs_init_server(struct nfs_server *server,
741 const struct nfs_parsed_mount_data *data,
742 struct nfs_subversion *nfs_mod)
744 struct nfs_client_initdata cl_init = {
745 .hostname = data->nfs_server.hostname,
746 .addr = (const struct sockaddr *)&data->nfs_server.address,
747 .addrlen = data->nfs_server.addrlen,
749 .proto = data->nfs_server.protocol,
752 struct rpc_timeout timeparms;
753 struct nfs_client *clp;
756 dprintk("--> nfs_init_server()\n");
758 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
759 data->timeo, data->retrans);
760 if (data->flags & NFS_MOUNT_NORESVPORT)
761 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
763 /* Allocate or find a client reference we can use */
764 clp = nfs_get_client(&cl_init, &timeparms, NULL, RPC_AUTH_UNIX);
766 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
770 server->nfs_client = clp;
772 /* Initialise the client representation from the mount data */
773 server->flags = data->flags;
774 server->options = data->options;
775 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
776 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
777 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME|NFS_CAP_CHANGE_ATTR;
780 server->rsize = nfs_block_size(data->rsize, NULL);
782 server->wsize = nfs_block_size(data->wsize, NULL);
784 server->acregmin = data->acregmin * HZ;
785 server->acregmax = data->acregmax * HZ;
786 server->acdirmin = data->acdirmin * HZ;
787 server->acdirmax = data->acdirmax * HZ;
789 /* Start lockd here, before we might error out */
790 error = nfs_start_lockd(server);
794 server->port = data->nfs_server.port;
795 server->auth_info = data->auth_info;
797 error = nfs_init_server_rpcclient(server, &timeparms,
798 data->selected_flavor);
802 /* Preserve the values of mount_server-related mount options */
803 if (data->mount_server.addrlen) {
804 memcpy(&server->mountd_address, &data->mount_server.address,
805 data->mount_server.addrlen);
806 server->mountd_addrlen = data->mount_server.addrlen;
808 server->mountd_version = data->mount_server.version;
809 server->mountd_port = data->mount_server.port;
810 server->mountd_protocol = data->mount_server.protocol;
812 server->namelen = data->namlen;
813 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
817 server->nfs_client = NULL;
819 dprintk("<-- nfs_init_server() = xerror %d\n", error);
824 * Load up the server record from information gained in an fsinfo record
826 static void nfs_server_set_fsinfo(struct nfs_server *server,
827 struct nfs_fh *mntfh,
828 struct nfs_fsinfo *fsinfo)
830 unsigned long max_rpc_payload;
832 /* Work out a lot of parameters */
833 if (server->rsize == 0)
834 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
835 if (server->wsize == 0)
836 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
838 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
839 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
840 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
841 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
843 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
844 if (server->rsize > max_rpc_payload)
845 server->rsize = max_rpc_payload;
846 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
847 server->rsize = NFS_MAX_FILE_IO_SIZE;
848 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
850 server->backing_dev_info.name = "nfs";
851 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
853 if (server->wsize > max_rpc_payload)
854 server->wsize = max_rpc_payload;
855 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
856 server->wsize = NFS_MAX_FILE_IO_SIZE;
857 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
859 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
861 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
862 if (server->dtsize > PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES)
863 server->dtsize = PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES;
864 if (server->dtsize > server->rsize)
865 server->dtsize = server->rsize;
867 if (server->flags & NFS_MOUNT_NOAC) {
868 server->acregmin = server->acregmax = 0;
869 server->acdirmin = server->acdirmax = 0;
872 server->maxfilesize = fsinfo->maxfilesize;
874 server->time_delta = fsinfo->time_delta;
876 /* We're airborne Set socket buffersize */
877 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
881 * Probe filesystem information, including the FSID on v2/v3
883 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
885 struct nfs_fsinfo fsinfo;
886 struct nfs_client *clp = server->nfs_client;
889 dprintk("--> nfs_probe_fsinfo()\n");
891 if (clp->rpc_ops->set_capabilities != NULL) {
892 error = clp->rpc_ops->set_capabilities(server, mntfh);
897 fsinfo.fattr = fattr;
898 fsinfo.layouttype = 0;
899 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
903 nfs_server_set_fsinfo(server, mntfh, &fsinfo);
905 /* Get some general file system info */
906 if (server->namelen == 0) {
907 struct nfs_pathconf pathinfo;
909 pathinfo.fattr = fattr;
910 nfs_fattr_init(fattr);
912 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
913 server->namelen = pathinfo.max_namelen;
916 dprintk("<-- nfs_probe_fsinfo() = 0\n");
920 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
923 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
926 * Copy useful information when duplicating a server record
928 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
930 target->flags = source->flags;
931 target->rsize = source->rsize;
932 target->wsize = source->wsize;
933 target->acregmin = source->acregmin;
934 target->acregmax = source->acregmax;
935 target->acdirmin = source->acdirmin;
936 target->acdirmax = source->acdirmax;
937 target->caps = source->caps;
938 target->options = source->options;
939 target->auth_info = source->auth_info;
941 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
943 void nfs_server_insert_lists(struct nfs_server *server)
945 struct nfs_client *clp = server->nfs_client;
946 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
948 spin_lock(&nn->nfs_client_lock);
949 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
950 list_add_tail(&server->master_link, &nn->nfs_volume_list);
951 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
952 spin_unlock(&nn->nfs_client_lock);
955 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
957 void nfs_server_remove_lists(struct nfs_server *server)
959 struct nfs_client *clp = server->nfs_client;
964 nn = net_generic(clp->cl_net, nfs_net_id);
965 spin_lock(&nn->nfs_client_lock);
966 list_del_rcu(&server->client_link);
967 if (list_empty(&clp->cl_superblocks))
968 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
969 list_del(&server->master_link);
970 spin_unlock(&nn->nfs_client_lock);
974 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
977 * Allocate and initialise a server record
979 struct nfs_server *nfs_alloc_server(void)
981 struct nfs_server *server;
983 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
987 server->client = server->client_acl = ERR_PTR(-EINVAL);
989 /* Zero out the NFS state stuff */
990 INIT_LIST_HEAD(&server->client_link);
991 INIT_LIST_HEAD(&server->master_link);
992 INIT_LIST_HEAD(&server->delegations);
993 INIT_LIST_HEAD(&server->layouts);
994 INIT_LIST_HEAD(&server->state_owners_lru);
996 atomic_set(&server->active, 0);
998 server->io_stats = nfs_alloc_iostats();
999 if (!server->io_stats) {
1004 if (bdi_init(&server->backing_dev_info)) {
1005 nfs_free_iostats(server->io_stats);
1010 ida_init(&server->openowner_id);
1011 ida_init(&server->lockowner_id);
1012 pnfs_init_server(server);
1016 EXPORT_SYMBOL_GPL(nfs_alloc_server);
1019 * Free up a server record
1021 void nfs_free_server(struct nfs_server *server)
1023 dprintk("--> nfs_free_server()\n");
1025 nfs_server_remove_lists(server);
1027 if (server->destroy != NULL)
1028 server->destroy(server);
1030 if (!IS_ERR(server->client_acl))
1031 rpc_shutdown_client(server->client_acl);
1032 if (!IS_ERR(server->client))
1033 rpc_shutdown_client(server->client);
1035 nfs_put_client(server->nfs_client);
1037 ida_destroy(&server->lockowner_id);
1038 ida_destroy(&server->openowner_id);
1039 nfs_free_iostats(server->io_stats);
1040 bdi_destroy(&server->backing_dev_info);
1042 nfs_release_automount_timer();
1043 dprintk("<-- nfs_free_server()\n");
1045 EXPORT_SYMBOL_GPL(nfs_free_server);
1048 * Create a version 2 or 3 volume record
1049 * - keyed on server and FSID
1051 struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
1052 struct nfs_subversion *nfs_mod)
1054 struct nfs_server *server;
1055 struct nfs_fattr *fattr;
1058 server = nfs_alloc_server();
1060 return ERR_PTR(-ENOMEM);
1063 fattr = nfs_alloc_fattr();
1067 /* Get a client representation */
1068 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
1072 /* Probe the root fh to retrieve its FSID */
1073 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
1076 if (server->nfs_client->rpc_ops->version == 3) {
1077 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1078 server->namelen = NFS3_MAXNAMLEN;
1079 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
1080 server->caps |= NFS_CAP_READDIRPLUS;
1082 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1083 server->namelen = NFS2_MAXNAMLEN;
1086 if (!(fattr->valid & NFS_ATTR_FATTR)) {
1087 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr, NULL);
1089 dprintk("nfs_create_server: getattr error = %d\n", -error);
1093 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1095 dprintk("Server FSID: %llx:%llx\n",
1096 (unsigned long long) server->fsid.major,
1097 (unsigned long long) server->fsid.minor);
1099 nfs_server_insert_lists(server);
1100 server->mount_time = jiffies;
1101 nfs_free_fattr(fattr);
1105 nfs_free_fattr(fattr);
1106 nfs_free_server(server);
1107 return ERR_PTR(error);
1109 EXPORT_SYMBOL_GPL(nfs_create_server);
1112 * Clone an NFS2, NFS3 or NFS4 server record
1114 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1116 struct nfs_fattr *fattr,
1117 rpc_authflavor_t flavor)
1119 struct nfs_server *server;
1120 struct nfs_fattr *fattr_fsinfo;
1123 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1124 (unsigned long long) fattr->fsid.major,
1125 (unsigned long long) fattr->fsid.minor);
1127 server = nfs_alloc_server();
1129 return ERR_PTR(-ENOMEM);
1132 fattr_fsinfo = nfs_alloc_fattr();
1133 if (fattr_fsinfo == NULL)
1134 goto out_free_server;
1136 /* Copy data from the source */
1137 server->nfs_client = source->nfs_client;
1138 server->destroy = source->destroy;
1139 atomic_inc(&server->nfs_client->cl_count);
1140 nfs_server_copy_userdata(server, source);
1142 server->fsid = fattr->fsid;
1144 error = nfs_init_server_rpcclient(server,
1145 source->client->cl_timeout,
1148 goto out_free_server;
1150 /* probe the filesystem info for this server filesystem */
1151 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1153 goto out_free_server;
1155 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1156 server->namelen = NFS4_MAXNAMLEN;
1158 dprintk("Cloned FSID: %llx:%llx\n",
1159 (unsigned long long) server->fsid.major,
1160 (unsigned long long) server->fsid.minor);
1162 error = nfs_start_lockd(server);
1164 goto out_free_server;
1166 nfs_server_insert_lists(server);
1167 server->mount_time = jiffies;
1169 nfs_free_fattr(fattr_fsinfo);
1170 dprintk("<-- nfs_clone_server() = %p\n", server);
1174 nfs_free_fattr(fattr_fsinfo);
1175 nfs_free_server(server);
1176 dprintk("<-- nfs_clone_server() = error %d\n", error);
1177 return ERR_PTR(error);
1179 EXPORT_SYMBOL_GPL(nfs_clone_server);
1181 void nfs_clients_init(struct net *net)
1183 struct nfs_net *nn = net_generic(net, nfs_net_id);
1185 INIT_LIST_HEAD(&nn->nfs_client_list);
1186 INIT_LIST_HEAD(&nn->nfs_volume_list);
1187 #if IS_ENABLED(CONFIG_NFS_V4)
1188 idr_init(&nn->cb_ident_idr);
1190 spin_lock_init(&nn->nfs_client_lock);
1191 nn->boot_time = CURRENT_TIME;
1194 #ifdef CONFIG_PROC_FS
1195 static struct proc_dir_entry *proc_fs_nfs;
1197 static int nfs_server_list_open(struct inode *inode, struct file *file);
1198 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1199 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1200 static void nfs_server_list_stop(struct seq_file *p, void *v);
1201 static int nfs_server_list_show(struct seq_file *m, void *v);
1203 static const struct seq_operations nfs_server_list_ops = {
1204 .start = nfs_server_list_start,
1205 .next = nfs_server_list_next,
1206 .stop = nfs_server_list_stop,
1207 .show = nfs_server_list_show,
1210 static const struct file_operations nfs_server_list_fops = {
1211 .open = nfs_server_list_open,
1213 .llseek = seq_lseek,
1214 .release = seq_release,
1215 .owner = THIS_MODULE,
1218 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1219 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1220 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1221 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1222 static int nfs_volume_list_show(struct seq_file *m, void *v);
1224 static const struct seq_operations nfs_volume_list_ops = {
1225 .start = nfs_volume_list_start,
1226 .next = nfs_volume_list_next,
1227 .stop = nfs_volume_list_stop,
1228 .show = nfs_volume_list_show,
1231 static const struct file_operations nfs_volume_list_fops = {
1232 .open = nfs_volume_list_open,
1234 .llseek = seq_lseek,
1235 .release = seq_release,
1236 .owner = THIS_MODULE,
1240 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1243 static int nfs_server_list_open(struct inode *inode, struct file *file)
1247 struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1248 struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1250 ret = seq_open(file, &nfs_server_list_ops);
1254 m = file->private_data;
1261 * set up the iterator to start reading from the server list and return the first item
1263 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1265 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1267 /* lock the list against modification */
1268 spin_lock(&nn->nfs_client_lock);
1269 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1273 * move to next server
1275 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1277 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1279 return seq_list_next(v, &nn->nfs_client_list, pos);
1283 * clean up after reading from the transports list
1285 static void nfs_server_list_stop(struct seq_file *p, void *v)
1287 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1289 spin_unlock(&nn->nfs_client_lock);
1293 * display a header line followed by a load of call lines
1295 static int nfs_server_list_show(struct seq_file *m, void *v)
1297 struct nfs_client *clp;
1298 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1300 /* display header on line 1 */
1301 if (v == &nn->nfs_client_list) {
1302 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1306 /* display one transport per line on subsequent lines */
1307 clp = list_entry(v, struct nfs_client, cl_share_link);
1309 /* Check if the client is initialized */
1310 if (clp->cl_cons_state != NFS_CS_READY)
1314 seq_printf(m, "v%u %s %s %3d %s\n",
1315 clp->rpc_ops->version,
1316 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1317 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1318 atomic_read(&clp->cl_count),
1326 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1328 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1332 struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1333 struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1335 ret = seq_open(file, &nfs_volume_list_ops);
1339 m = file->private_data;
1346 * set up the iterator to start reading from the volume list and return the first item
1348 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1350 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1352 /* lock the list against modification */
1353 spin_lock(&nn->nfs_client_lock);
1354 return seq_list_start_head(&nn->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 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1364 return seq_list_next(v, &nn->nfs_volume_list, pos);
1368 * clean up after reading from the transports list
1370 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1372 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1374 spin_unlock(&nn->nfs_client_lock);
1378 * display a header line followed by a load of call lines
1380 static int nfs_volume_list_show(struct seq_file *m, void *v)
1382 struct nfs_server *server;
1383 struct nfs_client *clp;
1384 char dev[8], fsid[17];
1385 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1387 /* display header on line 1 */
1388 if (v == &nn->nfs_volume_list) {
1389 seq_puts(m, "NV SERVER PORT DEV FSID FSC\n");
1392 /* display one transport per line on subsequent lines */
1393 server = list_entry(v, struct nfs_server, master_link);
1394 clp = server->nfs_client;
1396 snprintf(dev, 8, "%u:%u",
1397 MAJOR(server->s_dev), MINOR(server->s_dev));
1399 snprintf(fsid, 17, "%llx:%llx",
1400 (unsigned long long) server->fsid.major,
1401 (unsigned long long) server->fsid.minor);
1404 seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
1405 clp->rpc_ops->version,
1406 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1407 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1410 nfs_server_fscache_state(server));
1417 * initialise the /proc/fs/nfsfs/ directory
1419 int __init nfs_fs_proc_init(void)
1421 struct proc_dir_entry *p;
1423 proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1427 /* a file of servers with which we're dealing */
1428 p = proc_create("servers", S_IFREG|S_IRUGO,
1429 proc_fs_nfs, &nfs_server_list_fops);
1433 /* a file of volumes that we have mounted */
1434 p = proc_create("volumes", S_IFREG|S_IRUGO,
1435 proc_fs_nfs, &nfs_volume_list_fops);
1441 remove_proc_entry("servers", proc_fs_nfs);
1443 remove_proc_entry("fs/nfsfs", NULL);
1449 * clean up the /proc/fs/nfsfs/ directory
1451 void nfs_fs_proc_exit(void)
1453 remove_proc_entry("volumes", proc_fs_nfs);
1454 remove_proc_entry("servers", proc_fs_nfs);
1455 remove_proc_entry("fs/nfsfs", NULL);
1458 #endif /* CONFIG_PROC_FS */