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);
257 dprintk("<-- nfs_free_client()\n");
259 EXPORT_SYMBOL_GPL(nfs_free_client);
262 * Release a reference to a shared client record
264 void nfs_put_client(struct nfs_client *clp)
271 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
272 nn = net_generic(clp->cl_net, nfs_net_id);
274 if (atomic_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
275 list_del(&clp->cl_share_link);
276 nfs_cb_idr_remove_locked(clp);
277 spin_unlock(&nn->nfs_client_lock);
279 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
281 clp->rpc_ops->free_client(clp);
284 EXPORT_SYMBOL_GPL(nfs_put_client);
286 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
288 * Test if two ip6 socket addresses refer to the same socket by
289 * comparing relevant fields. The padding bytes specifically, are not
290 * compared. sin6_flowinfo is not compared because it only affects QoS
291 * and sin6_scope_id is only compared if the address is "link local"
292 * because "link local" addresses need only be unique to a specific
293 * link. Conversely, ordinary unicast addresses might have different
296 * The caller should ensure both socket addresses are AF_INET6.
298 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
299 const struct sockaddr *sa2)
301 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
302 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
304 if (!ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr))
306 else if (ipv6_addr_type(&sin1->sin6_addr) & IPV6_ADDR_LINKLOCAL)
307 return sin1->sin6_scope_id == sin2->sin6_scope_id;
311 #else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
312 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
313 const struct sockaddr *sa2)
320 * Test if two ip4 socket addresses refer to the same socket, by
321 * comparing relevant fields. The padding bytes specifically, are
324 * The caller should ensure both socket addresses are AF_INET.
326 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr *sa1,
327 const struct sockaddr *sa2)
329 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
330 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
332 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
335 static int nfs_sockaddr_cmp_ip6(const struct sockaddr *sa1,
336 const struct sockaddr *sa2)
338 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
339 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
341 return nfs_sockaddr_match_ipaddr6(sa1, sa2) &&
342 (sin1->sin6_port == sin2->sin6_port);
345 static int nfs_sockaddr_cmp_ip4(const struct sockaddr *sa1,
346 const struct sockaddr *sa2)
348 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
349 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
351 return nfs_sockaddr_match_ipaddr4(sa1, sa2) &&
352 (sin1->sin_port == sin2->sin_port);
355 #if defined(CONFIG_NFS_V4_1)
357 * Test if two socket addresses represent the same actual socket,
358 * by comparing (only) relevant fields, excluding the port number.
360 int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
361 const struct sockaddr *sa2)
363 if (sa1->sa_family != sa2->sa_family)
366 switch (sa1->sa_family) {
368 return nfs_sockaddr_match_ipaddr4(sa1, sa2);
370 return nfs_sockaddr_match_ipaddr6(sa1, sa2);
374 EXPORT_SYMBOL_GPL(nfs_sockaddr_match_ipaddr);
375 #endif /* CONFIG_NFS_V4_1 */
378 * Test if two socket addresses represent the same actual socket,
379 * by comparing (only) relevant fields, including the port number.
381 static int nfs_sockaddr_cmp(const struct sockaddr *sa1,
382 const struct sockaddr *sa2)
384 if (sa1->sa_family != sa2->sa_family)
387 switch (sa1->sa_family) {
389 return nfs_sockaddr_cmp_ip4(sa1, sa2);
391 return nfs_sockaddr_cmp_ip6(sa1, sa2);
397 * Find an nfs_client on the list that matches the initialisation data
400 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
402 struct nfs_client *clp;
403 const struct sockaddr *sap = data->addr;
404 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
406 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
407 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
408 /* Don't match clients that failed to initialise properly */
409 if (clp->cl_cons_state < 0)
412 /* Different NFS versions cannot share the same nfs_client */
413 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
416 if (clp->cl_proto != data->proto)
418 /* Match nfsv4 minorversion */
419 if (clp->cl_minorversion != data->minorversion)
421 /* Match the full socket address */
422 if (!nfs_sockaddr_cmp(sap, clap))
425 atomic_inc(&clp->cl_count);
431 static bool nfs_client_init_is_complete(const struct nfs_client *clp)
433 return clp->cl_cons_state != NFS_CS_INITING;
436 int nfs_wait_client_init_complete(const struct nfs_client *clp)
438 return wait_event_killable(nfs_client_active_wq,
439 nfs_client_init_is_complete(clp));
441 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
444 * Found an existing client. Make sure it's ready before returning.
446 static struct nfs_client *
447 nfs_found_client(const struct nfs_client_initdata *cl_init,
448 struct nfs_client *clp)
452 error = nfs_wait_client_init_complete(clp);
455 return ERR_PTR(-ERESTARTSYS);
458 if (clp->cl_cons_state < NFS_CS_READY) {
459 error = clp->cl_cons_state;
461 return ERR_PTR(error);
466 dprintk("<-- %s found nfs_client %p for %s\n",
467 __func__, clp, cl_init->hostname ?: "");
472 * Look up a client by IP address and protocol version
473 * - creates a new record if one doesn't yet exist
476 nfs_get_client(const struct nfs_client_initdata *cl_init,
477 const struct rpc_timeout *timeparms,
479 rpc_authflavor_t authflavour)
481 struct nfs_client *clp, *new = NULL;
482 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
483 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
485 dprintk("--> nfs_get_client(%s,v%u)\n",
486 cl_init->hostname ?: "", rpc_ops->version);
488 /* see if the client already exists */
490 spin_lock(&nn->nfs_client_lock);
492 clp = nfs_match_client(cl_init);
494 spin_unlock(&nn->nfs_client_lock);
496 new->rpc_ops->free_client(new);
497 return nfs_found_client(cl_init, clp);
500 list_add_tail(&new->cl_share_link,
501 &nn->nfs_client_list);
502 spin_unlock(&nn->nfs_client_lock);
503 new->cl_flags = cl_init->init_flags;
504 return rpc_ops->init_client(new, timeparms, ip_addr,
508 spin_unlock(&nn->nfs_client_lock);
510 new = rpc_ops->alloc_client(cl_init);
511 } while (!IS_ERR(new));
513 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
514 cl_init->hostname ?: "", PTR_ERR(new));
517 EXPORT_SYMBOL_GPL(nfs_get_client);
520 * Mark a server as ready or failed
522 void nfs_mark_client_ready(struct nfs_client *clp, int state)
525 clp->cl_cons_state = state;
526 wake_up_all(&nfs_client_active_wq);
528 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
531 * Initialise the timeout values for a connection
533 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
534 unsigned int timeo, unsigned int retrans)
536 to->to_initval = timeo * HZ / 10;
537 to->to_retries = retrans;
540 case XPRT_TRANSPORT_TCP:
541 case XPRT_TRANSPORT_RDMA:
542 if (to->to_retries == 0)
543 to->to_retries = NFS_DEF_TCP_RETRANS;
544 if (to->to_initval == 0)
545 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
546 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
547 to->to_initval = NFS_MAX_TCP_TIMEOUT;
548 to->to_increment = to->to_initval;
549 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
550 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
551 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
552 if (to->to_maxval < to->to_initval)
553 to->to_maxval = to->to_initval;
554 to->to_exponential = 0;
556 case XPRT_TRANSPORT_UDP:
557 if (to->to_retries == 0)
558 to->to_retries = NFS_DEF_UDP_RETRANS;
560 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
561 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
562 to->to_initval = NFS_MAX_UDP_TIMEOUT;
563 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
564 to->to_exponential = 1;
570 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
573 * Create an RPC client handle
575 int nfs_create_rpc_client(struct nfs_client *clp,
576 const struct rpc_timeout *timeparms,
577 rpc_authflavor_t flavor)
579 struct rpc_clnt *clnt = NULL;
580 struct rpc_create_args args = {
582 .protocol = clp->cl_proto,
583 .address = (struct sockaddr *)&clp->cl_addr,
584 .addrsize = clp->cl_addrlen,
585 .timeout = timeparms,
586 .servername = clp->cl_hostname,
587 .program = &nfs_program,
588 .version = clp->rpc_ops->version,
589 .authflavor = flavor,
592 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
593 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
594 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
595 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
596 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
597 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
599 if (!IS_ERR(clp->cl_rpcclient))
602 clnt = rpc_create(&args);
604 dprintk("%s: cannot create RPC client. Error = %ld\n",
605 __func__, PTR_ERR(clnt));
606 return PTR_ERR(clnt);
609 clp->cl_rpcclient = clnt;
612 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
615 * Version 2 or 3 client destruction
617 static void nfs_destroy_server(struct nfs_server *server)
619 if (server->nlm_host)
620 nlmclnt_done(server->nlm_host);
624 * Version 2 or 3 lockd setup
626 static int nfs_start_lockd(struct nfs_server *server)
628 struct nlm_host *host;
629 struct nfs_client *clp = server->nfs_client;
630 struct nlmclnt_initdata nlm_init = {
631 .hostname = clp->cl_hostname,
632 .address = (struct sockaddr *)&clp->cl_addr,
633 .addrlen = clp->cl_addrlen,
634 .nfs_version = clp->rpc_ops->version,
635 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
640 if (nlm_init.nfs_version > 3)
642 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
643 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
646 switch (clp->cl_proto) {
648 nlm_init.protocol = IPPROTO_TCP;
650 case XPRT_TRANSPORT_UDP:
651 nlm_init.protocol = IPPROTO_UDP;
654 host = nlmclnt_init(&nlm_init);
656 return PTR_ERR(host);
658 server->nlm_host = host;
659 server->destroy = nfs_destroy_server;
664 * Create a general RPC client
666 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_set_auth(clp->cl_rpcclient,
674 if (IS_ERR(server->client)) {
675 dprintk("%s: couldn't create rpc_client!\n", __func__);
676 return PTR_ERR(server->client);
679 memcpy(&server->client->cl_timeout_default,
681 sizeof(server->client->cl_timeout_default));
682 server->client->cl_timeout = &server->client->cl_timeout_default;
683 server->client->cl_softrtry = 0;
684 if (server->flags & NFS_MOUNT_SOFT)
685 server->client->cl_softrtry = 1;
689 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
692 * nfs_init_client - Initialise an NFS2 or NFS3 client
694 * @clp: nfs_client to initialise
695 * @timeparms: timeout parameters for underlying RPC transport
696 * @ip_addr: IP presentation address (not used)
697 * @authflavor: authentication flavor for underlying RPC transport
699 * Returns pointer to an NFS client, or an ERR_PTR value.
701 struct nfs_client *nfs_init_client(struct nfs_client *clp,
702 const struct rpc_timeout *timeparms,
703 const char *ip_addr, rpc_authflavor_t authflavour)
707 if (clp->cl_cons_state == NFS_CS_READY) {
708 /* the client is already initialised */
709 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
714 * Create a client RPC handle for doing FSSTAT with UNIX auth only
715 * - RFC 2623, sec 2.3.2
717 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX);
720 nfs_mark_client_ready(clp, NFS_CS_READY);
724 nfs_mark_client_ready(clp, error);
726 dprintk("<-- nfs_init_client() = xerror %d\n", error);
727 return ERR_PTR(error);
729 EXPORT_SYMBOL_GPL(nfs_init_client);
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,
736 struct nfs_subversion *nfs_mod)
738 struct nfs_client_initdata cl_init = {
739 .hostname = data->nfs_server.hostname,
740 .addr = (const struct sockaddr *)&data->nfs_server.address,
741 .addrlen = data->nfs_server.addrlen,
743 .proto = data->nfs_server.protocol,
746 struct rpc_timeout timeparms;
747 struct nfs_client *clp;
750 dprintk("--> nfs_init_server()\n");
752 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
753 data->timeo, data->retrans);
754 if (data->flags & NFS_MOUNT_NORESVPORT)
755 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
756 if (server->options & NFS_OPTION_MIGRATION)
757 set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
759 /* Allocate or find a client reference we can use */
760 clp = nfs_get_client(&cl_init, &timeparms, NULL, RPC_AUTH_UNIX);
762 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
766 server->nfs_client = clp;
768 /* Initialise the client representation from the mount data */
769 server->flags = data->flags;
770 server->options = data->options;
771 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
772 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
773 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME|NFS_CAP_CHANGE_ATTR;
776 server->rsize = nfs_block_size(data->rsize, NULL);
778 server->wsize = nfs_block_size(data->wsize, NULL);
780 server->acregmin = data->acregmin * HZ;
781 server->acregmax = data->acregmax * HZ;
782 server->acdirmin = data->acdirmin * HZ;
783 server->acdirmax = data->acdirmax * HZ;
785 /* Start lockd here, before we might error out */
786 error = nfs_start_lockd(server);
790 server->port = data->nfs_server.port;
792 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
796 /* Preserve the values of mount_server-related mount options */
797 if (data->mount_server.addrlen) {
798 memcpy(&server->mountd_address, &data->mount_server.address,
799 data->mount_server.addrlen);
800 server->mountd_addrlen = data->mount_server.addrlen;
802 server->mountd_version = data->mount_server.version;
803 server->mountd_port = data->mount_server.port;
804 server->mountd_protocol = data->mount_server.protocol;
806 server->namelen = data->namlen;
807 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
811 server->nfs_client = NULL;
813 dprintk("<-- nfs_init_server() = xerror %d\n", error);
818 * Load up the server record from information gained in an fsinfo record
820 static void nfs_server_set_fsinfo(struct nfs_server *server,
821 struct nfs_fh *mntfh,
822 struct nfs_fsinfo *fsinfo)
824 unsigned long max_rpc_payload;
826 /* Work out a lot of parameters */
827 if (server->rsize == 0)
828 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
829 if (server->wsize == 0)
830 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
832 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
833 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
834 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
835 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
837 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
838 if (server->rsize > max_rpc_payload)
839 server->rsize = max_rpc_payload;
840 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
841 server->rsize = NFS_MAX_FILE_IO_SIZE;
842 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
844 server->backing_dev_info.name = "nfs";
845 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
847 if (server->wsize > max_rpc_payload)
848 server->wsize = max_rpc_payload;
849 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
850 server->wsize = NFS_MAX_FILE_IO_SIZE;
851 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
853 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
855 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
856 if (server->dtsize > PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES)
857 server->dtsize = PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES;
858 if (server->dtsize > server->rsize)
859 server->dtsize = server->rsize;
861 if (server->flags & NFS_MOUNT_NOAC) {
862 server->acregmin = server->acregmax = 0;
863 server->acdirmin = server->acdirmax = 0;
866 server->maxfilesize = fsinfo->maxfilesize;
868 server->time_delta = fsinfo->time_delta;
870 /* We're airborne Set socket buffersize */
871 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
875 * Probe filesystem information, including the FSID on v2/v3
877 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
879 struct nfs_fsinfo fsinfo;
880 struct nfs_client *clp = server->nfs_client;
883 dprintk("--> nfs_probe_fsinfo()\n");
885 if (clp->rpc_ops->set_capabilities != NULL) {
886 error = clp->rpc_ops->set_capabilities(server, mntfh);
891 fsinfo.fattr = fattr;
892 fsinfo.layouttype = 0;
893 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
897 nfs_server_set_fsinfo(server, mntfh, &fsinfo);
899 /* Get some general file system info */
900 if (server->namelen == 0) {
901 struct nfs_pathconf pathinfo;
903 pathinfo.fattr = fattr;
904 nfs_fattr_init(fattr);
906 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
907 server->namelen = pathinfo.max_namelen;
910 dprintk("<-- nfs_probe_fsinfo() = 0\n");
914 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
917 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
920 * Copy useful information when duplicating a server record
922 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
924 target->flags = source->flags;
925 target->rsize = source->rsize;
926 target->wsize = source->wsize;
927 target->acregmin = source->acregmin;
928 target->acregmax = source->acregmax;
929 target->acdirmin = source->acdirmin;
930 target->acdirmax = source->acdirmax;
931 target->caps = source->caps;
932 target->options = source->options;
934 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
936 void nfs_server_insert_lists(struct nfs_server *server)
938 struct nfs_client *clp = server->nfs_client;
939 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
941 spin_lock(&nn->nfs_client_lock);
942 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
943 list_add_tail(&server->master_link, &nn->nfs_volume_list);
944 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
945 spin_unlock(&nn->nfs_client_lock);
948 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
950 static void nfs_server_remove_lists(struct nfs_server *server)
952 struct nfs_client *clp = server->nfs_client;
957 nn = net_generic(clp->cl_net, nfs_net_id);
958 spin_lock(&nn->nfs_client_lock);
959 list_del_rcu(&server->client_link);
960 if (list_empty(&clp->cl_superblocks))
961 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
962 list_del(&server->master_link);
963 spin_unlock(&nn->nfs_client_lock);
969 * Allocate and initialise a server record
971 struct nfs_server *nfs_alloc_server(void)
973 struct nfs_server *server;
975 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
979 server->client = server->client_acl = ERR_PTR(-EINVAL);
981 /* Zero out the NFS state stuff */
982 INIT_LIST_HEAD(&server->client_link);
983 INIT_LIST_HEAD(&server->master_link);
984 INIT_LIST_HEAD(&server->delegations);
985 INIT_LIST_HEAD(&server->layouts);
986 INIT_LIST_HEAD(&server->state_owners_lru);
988 atomic_set(&server->active, 0);
990 server->io_stats = nfs_alloc_iostats();
991 if (!server->io_stats) {
996 if (bdi_init(&server->backing_dev_info)) {
997 nfs_free_iostats(server->io_stats);
1002 ida_init(&server->openowner_id);
1003 ida_init(&server->lockowner_id);
1004 pnfs_init_server(server);
1008 EXPORT_SYMBOL_GPL(nfs_alloc_server);
1011 * Free up a server record
1013 void nfs_free_server(struct nfs_server *server)
1015 dprintk("--> nfs_free_server()\n");
1017 nfs_server_remove_lists(server);
1019 if (server->destroy != NULL)
1020 server->destroy(server);
1022 if (!IS_ERR(server->client_acl))
1023 rpc_shutdown_client(server->client_acl);
1024 if (!IS_ERR(server->client))
1025 rpc_shutdown_client(server->client);
1027 nfs_put_client(server->nfs_client);
1029 ida_destroy(&server->lockowner_id);
1030 ida_destroy(&server->openowner_id);
1031 nfs_free_iostats(server->io_stats);
1032 bdi_destroy(&server->backing_dev_info);
1034 nfs_release_automount_timer();
1035 dprintk("<-- nfs_free_server()\n");
1037 EXPORT_SYMBOL_GPL(nfs_free_server);
1040 * Create a version 2 or 3 volume record
1041 * - keyed on server and FSID
1043 struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
1044 struct nfs_subversion *nfs_mod)
1046 struct nfs_server *server;
1047 struct nfs_fattr *fattr;
1050 server = nfs_alloc_server();
1052 return ERR_PTR(-ENOMEM);
1055 fattr = nfs_alloc_fattr();
1059 /* Get a client representation */
1060 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
1064 /* Probe the root fh to retrieve its FSID */
1065 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
1068 if (server->nfs_client->rpc_ops->version == 3) {
1069 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1070 server->namelen = NFS3_MAXNAMLEN;
1071 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
1072 server->caps |= NFS_CAP_READDIRPLUS;
1074 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1075 server->namelen = NFS2_MAXNAMLEN;
1078 if (!(fattr->valid & NFS_ATTR_FATTR)) {
1079 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr);
1081 dprintk("nfs_create_server: getattr error = %d\n", -error);
1085 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1087 dprintk("Server FSID: %llx:%llx\n",
1088 (unsigned long long) server->fsid.major,
1089 (unsigned long long) server->fsid.minor);
1091 nfs_server_insert_lists(server);
1092 server->mount_time = jiffies;
1093 nfs_free_fattr(fattr);
1097 nfs_free_fattr(fattr);
1098 nfs_free_server(server);
1099 return ERR_PTR(error);
1101 EXPORT_SYMBOL_GPL(nfs_create_server);
1104 * Clone an NFS2, NFS3 or NFS4 server record
1106 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1108 struct nfs_fattr *fattr,
1109 rpc_authflavor_t flavor)
1111 struct nfs_server *server;
1112 struct nfs_fattr *fattr_fsinfo;
1115 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1116 (unsigned long long) fattr->fsid.major,
1117 (unsigned long long) fattr->fsid.minor);
1119 server = nfs_alloc_server();
1121 return ERR_PTR(-ENOMEM);
1124 fattr_fsinfo = nfs_alloc_fattr();
1125 if (fattr_fsinfo == NULL)
1126 goto out_free_server;
1128 /* Copy data from the source */
1129 server->nfs_client = source->nfs_client;
1130 server->destroy = source->destroy;
1131 atomic_inc(&server->nfs_client->cl_count);
1132 nfs_server_copy_userdata(server, source);
1134 server->fsid = fattr->fsid;
1136 error = nfs_init_server_rpcclient(server,
1137 source->client->cl_timeout,
1140 goto out_free_server;
1142 /* probe the filesystem info for this server filesystem */
1143 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1145 goto out_free_server;
1147 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1148 server->namelen = NFS4_MAXNAMLEN;
1150 dprintk("Cloned FSID: %llx:%llx\n",
1151 (unsigned long long) server->fsid.major,
1152 (unsigned long long) server->fsid.minor);
1154 error = nfs_start_lockd(server);
1156 goto out_free_server;
1158 nfs_server_insert_lists(server);
1159 server->mount_time = jiffies;
1161 nfs_free_fattr(fattr_fsinfo);
1162 dprintk("<-- nfs_clone_server() = %p\n", server);
1166 nfs_free_fattr(fattr_fsinfo);
1167 nfs_free_server(server);
1168 dprintk("<-- nfs_clone_server() = error %d\n", error);
1169 return ERR_PTR(error);
1171 EXPORT_SYMBOL_GPL(nfs_clone_server);
1173 void nfs_clients_init(struct net *net)
1175 struct nfs_net *nn = net_generic(net, nfs_net_id);
1177 INIT_LIST_HEAD(&nn->nfs_client_list);
1178 INIT_LIST_HEAD(&nn->nfs_volume_list);
1179 #if IS_ENABLED(CONFIG_NFS_V4)
1180 idr_init(&nn->cb_ident_idr);
1182 spin_lock_init(&nn->nfs_client_lock);
1183 nn->boot_time = CURRENT_TIME;
1186 #ifdef CONFIG_PROC_FS
1187 static struct proc_dir_entry *proc_fs_nfs;
1189 static int nfs_server_list_open(struct inode *inode, struct file *file);
1190 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1191 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1192 static void nfs_server_list_stop(struct seq_file *p, void *v);
1193 static int nfs_server_list_show(struct seq_file *m, void *v);
1195 static const struct seq_operations nfs_server_list_ops = {
1196 .start = nfs_server_list_start,
1197 .next = nfs_server_list_next,
1198 .stop = nfs_server_list_stop,
1199 .show = nfs_server_list_show,
1202 static const struct file_operations nfs_server_list_fops = {
1203 .open = nfs_server_list_open,
1205 .llseek = seq_lseek,
1206 .release = seq_release,
1207 .owner = THIS_MODULE,
1210 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1211 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1212 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1213 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1214 static int nfs_volume_list_show(struct seq_file *m, void *v);
1216 static const struct seq_operations nfs_volume_list_ops = {
1217 .start = nfs_volume_list_start,
1218 .next = nfs_volume_list_next,
1219 .stop = nfs_volume_list_stop,
1220 .show = nfs_volume_list_show,
1223 static const struct file_operations nfs_volume_list_fops = {
1224 .open = nfs_volume_list_open,
1226 .llseek = seq_lseek,
1227 .release = seq_release,
1228 .owner = THIS_MODULE,
1232 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1235 static int nfs_server_list_open(struct inode *inode, struct file *file)
1239 struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1240 struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1242 ret = seq_open(file, &nfs_server_list_ops);
1246 m = file->private_data;
1253 * set up the iterator to start reading from the server list and return the first item
1255 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1257 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1259 /* lock the list against modification */
1260 spin_lock(&nn->nfs_client_lock);
1261 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1265 * move to next server
1267 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1269 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1271 return seq_list_next(v, &nn->nfs_client_list, pos);
1275 * clean up after reading from the transports list
1277 static void nfs_server_list_stop(struct seq_file *p, void *v)
1279 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1281 spin_unlock(&nn->nfs_client_lock);
1285 * display a header line followed by a load of call lines
1287 static int nfs_server_list_show(struct seq_file *m, void *v)
1289 struct nfs_client *clp;
1290 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1292 /* display header on line 1 */
1293 if (v == &nn->nfs_client_list) {
1294 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1298 /* display one transport per line on subsequent lines */
1299 clp = list_entry(v, struct nfs_client, cl_share_link);
1301 /* Check if the client is initialized */
1302 if (clp->cl_cons_state != NFS_CS_READY)
1306 seq_printf(m, "v%u %s %s %3d %s\n",
1307 clp->rpc_ops->version,
1308 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1309 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1310 atomic_read(&clp->cl_count),
1318 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1320 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1324 struct pid_namespace *pid_ns = file->f_dentry->d_sb->s_fs_info;
1325 struct net *net = pid_ns->child_reaper->nsproxy->net_ns;
1327 ret = seq_open(file, &nfs_volume_list_ops);
1331 m = file->private_data;
1338 * set up the iterator to start reading from the volume list and return the first item
1340 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1342 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1344 /* lock the list against modification */
1345 spin_lock(&nn->nfs_client_lock);
1346 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1350 * move to next volume
1352 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1354 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1356 return seq_list_next(v, &nn->nfs_volume_list, pos);
1360 * clean up after reading from the transports list
1362 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1364 struct nfs_net *nn = net_generic(p->private, nfs_net_id);
1366 spin_unlock(&nn->nfs_client_lock);
1370 * display a header line followed by a load of call lines
1372 static int nfs_volume_list_show(struct seq_file *m, void *v)
1374 struct nfs_server *server;
1375 struct nfs_client *clp;
1376 char dev[8], fsid[17];
1377 struct nfs_net *nn = net_generic(m->private, nfs_net_id);
1379 /* display header on line 1 */
1380 if (v == &nn->nfs_volume_list) {
1381 seq_puts(m, "NV SERVER PORT DEV FSID FSC\n");
1384 /* display one transport per line on subsequent lines */
1385 server = list_entry(v, struct nfs_server, master_link);
1386 clp = server->nfs_client;
1388 snprintf(dev, 8, "%u:%u",
1389 MAJOR(server->s_dev), MINOR(server->s_dev));
1391 snprintf(fsid, 17, "%llx:%llx",
1392 (unsigned long long) server->fsid.major,
1393 (unsigned long long) server->fsid.minor);
1396 seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
1397 clp->rpc_ops->version,
1398 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1399 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1402 nfs_server_fscache_state(server));
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("fs/nfsfs", NULL);
1419 /* a file of servers with which we're dealing */
1420 p = proc_create("servers", S_IFREG|S_IRUGO,
1421 proc_fs_nfs, &nfs_server_list_fops);
1425 /* a file of volumes that we have mounted */
1426 p = proc_create("volumes", S_IFREG|S_IRUGO,
1427 proc_fs_nfs, &nfs_volume_list_fops);
1433 remove_proc_entry("servers", proc_fs_nfs);
1435 remove_proc_entry("fs/nfsfs", NULL);
1441 * clean up the /proc/fs/nfsfs/ directory
1443 void nfs_fs_proc_exit(void)
1445 remove_proc_entry("volumes", proc_fs_nfs);
1446 remove_proc_entry("servers", proc_fs_nfs);
1447 remove_proc_entry("fs/nfsfs", NULL);
1450 #endif /* CONFIG_PROC_FS */