1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* client.c: NFS client sharing and management code
4 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
9 #include <linux/module.h>
10 #include <linux/init.h>
11 #include <linux/sched.h>
12 #include <linux/time.h>
13 #include <linux/kernel.h>
15 #include <linux/string.h>
16 #include <linux/stat.h>
17 #include <linux/errno.h>
18 #include <linux/unistd.h>
19 #include <linux/sunrpc/addr.h>
20 #include <linux/sunrpc/clnt.h>
21 #include <linux/sunrpc/stats.h>
22 #include <linux/sunrpc/metrics.h>
23 #include <linux/sunrpc/xprtsock.h>
24 #include <linux/sunrpc/xprtrdma.h>
25 #include <linux/nfs_fs.h>
26 #include <linux/nfs_mount.h>
27 #include <linux/nfs4_mount.h>
28 #include <linux/lockd/bind.h>
29 #include <linux/seq_file.h>
30 #include <linux/mount.h>
31 #include <linux/vfs.h>
32 #include <linux/inet.h>
33 #include <linux/in6.h>
34 #include <linux/slab.h>
35 #include <linux/idr.h>
37 #include <linux/nfs_xdr.h>
38 #include <linux/sunrpc/bc_xprt.h>
39 #include <linux/nsproxy.h>
40 #include <linux/pid_namespace.h>
45 #include "delegation.h"
55 #define NFSDBG_FACILITY NFSDBG_CLIENT
57 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
58 static DEFINE_SPINLOCK(nfs_version_lock);
59 static DEFINE_MUTEX(nfs_version_mutex);
60 static LIST_HEAD(nfs_versions);
65 static const struct rpc_version *nfs_version[5] = {
71 const struct rpc_program nfs_program = {
73 .number = NFS_PROGRAM,
74 .nrvers = ARRAY_SIZE(nfs_version),
75 .version = nfs_version,
76 .stats = &nfs_rpcstat,
77 .pipe_dir_name = NFS_PIPE_DIRNAME,
80 struct rpc_stat nfs_rpcstat = {
81 .program = &nfs_program
84 static struct nfs_subversion *find_nfs_version(unsigned int version)
86 struct nfs_subversion *nfs;
87 spin_lock(&nfs_version_lock);
89 list_for_each_entry(nfs, &nfs_versions, list) {
90 if (nfs->rpc_ops->version == version) {
91 spin_unlock(&nfs_version_lock);
96 spin_unlock(&nfs_version_lock);
97 return ERR_PTR(-EPROTONOSUPPORT);
100 struct nfs_subversion *get_nfs_version(unsigned int version)
102 struct nfs_subversion *nfs = find_nfs_version(version);
105 mutex_lock(&nfs_version_mutex);
106 request_module("nfsv%d", version);
107 nfs = find_nfs_version(version);
108 mutex_unlock(&nfs_version_mutex);
111 if (!IS_ERR(nfs) && !try_module_get(nfs->owner))
112 return ERR_PTR(-EAGAIN);
116 void put_nfs_version(struct nfs_subversion *nfs)
118 module_put(nfs->owner);
121 void register_nfs_version(struct nfs_subversion *nfs)
123 spin_lock(&nfs_version_lock);
125 list_add(&nfs->list, &nfs_versions);
126 nfs_version[nfs->rpc_ops->version] = nfs->rpc_vers;
128 spin_unlock(&nfs_version_lock);
130 EXPORT_SYMBOL_GPL(register_nfs_version);
132 void unregister_nfs_version(struct nfs_subversion *nfs)
134 spin_lock(&nfs_version_lock);
136 nfs_version[nfs->rpc_ops->version] = NULL;
137 list_del(&nfs->list);
139 spin_unlock(&nfs_version_lock);
141 EXPORT_SYMBOL_GPL(unregister_nfs_version);
144 * Allocate a shared client record
146 * Since these are allocated/deallocated very rarely, we don't
147 * bother putting them in a slab cache...
149 struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
151 struct nfs_client *clp;
154 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
157 clp->cl_minorversion = cl_init->minorversion;
158 clp->cl_nfs_mod = cl_init->nfs_mod;
159 if (!try_module_get(clp->cl_nfs_mod->owner))
162 clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
164 refcount_set(&clp->cl_count, 1);
165 clp->cl_cons_state = NFS_CS_INITING;
167 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
168 clp->cl_addrlen = cl_init->addrlen;
170 if (cl_init->hostname) {
172 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
173 if (!clp->cl_hostname)
177 INIT_LIST_HEAD(&clp->cl_superblocks);
178 clp->cl_rpcclient = ERR_PTR(-EINVAL);
180 clp->cl_flags = cl_init->init_flags;
181 clp->cl_proto = cl_init->proto;
182 clp->cl_nconnect = cl_init->nconnect;
183 clp->cl_max_connect = cl_init->max_connect ? cl_init->max_connect : 1;
184 clp->cl_net = get_net(cl_init->net);
186 clp->cl_principal = "*";
187 nfs_fscache_get_client_cookie(clp);
192 put_nfs_version(clp->cl_nfs_mod);
198 EXPORT_SYMBOL_GPL(nfs_alloc_client);
200 #if IS_ENABLED(CONFIG_NFS_V4)
201 static void nfs_cleanup_cb_ident_idr(struct net *net)
203 struct nfs_net *nn = net_generic(net, nfs_net_id);
205 idr_destroy(&nn->cb_ident_idr);
208 /* nfs_client_lock held */
209 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
211 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
213 if (clp->cl_cb_ident)
214 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
217 static void pnfs_init_server(struct nfs_server *server)
219 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
223 static void nfs_cleanup_cb_ident_idr(struct net *net)
227 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
231 static void pnfs_init_server(struct nfs_server *server)
235 #endif /* CONFIG_NFS_V4 */
238 * Destroy a shared client record
240 void nfs_free_client(struct nfs_client *clp)
242 nfs_fscache_release_client_cookie(clp);
244 /* -EIO all pending I/O */
245 if (!IS_ERR(clp->cl_rpcclient))
246 rpc_shutdown_client(clp->cl_rpcclient);
248 put_net(clp->cl_net);
249 put_nfs_version(clp->cl_nfs_mod);
250 kfree(clp->cl_hostname);
251 kfree(clp->cl_acceptor);
254 EXPORT_SYMBOL_GPL(nfs_free_client);
257 * Release a reference to a shared client record
259 void nfs_put_client(struct nfs_client *clp)
266 nn = net_generic(clp->cl_net, nfs_net_id);
268 if (refcount_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
269 list_del(&clp->cl_share_link);
270 nfs_cb_idr_remove_locked(clp);
271 spin_unlock(&nn->nfs_client_lock);
273 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
275 clp->rpc_ops->free_client(clp);
278 EXPORT_SYMBOL_GPL(nfs_put_client);
281 * Find an nfs_client on the list that matches the initialisation data
284 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
286 struct nfs_client *clp;
287 const struct sockaddr *sap = data->addr;
288 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
292 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
293 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
294 /* Don't match clients that failed to initialise properly */
295 if (clp->cl_cons_state < 0)
298 /* If a client is still initializing then we need to wait */
299 if (clp->cl_cons_state > NFS_CS_READY) {
300 refcount_inc(&clp->cl_count);
301 spin_unlock(&nn->nfs_client_lock);
302 error = nfs_wait_client_init_complete(clp);
304 spin_lock(&nn->nfs_client_lock);
306 return ERR_PTR(error);
310 /* Different NFS versions cannot share the same nfs_client */
311 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
314 if (clp->cl_proto != data->proto)
316 /* Match nfsv4 minorversion */
317 if (clp->cl_minorversion != data->minorversion)
320 /* Match request for a dedicated DS */
321 if (test_bit(NFS_CS_DS, &data->init_flags) !=
322 test_bit(NFS_CS_DS, &clp->cl_flags))
325 /* Match the full socket address */
326 if (!rpc_cmp_addr_port(sap, clap))
327 /* Match all xprt_switch full socket addresses */
328 if (IS_ERR(clp->cl_rpcclient) ||
329 !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
333 refcount_inc(&clp->cl_count);
340 * Return true if @clp is done initializing, false if still working on it.
342 * Use nfs_client_init_status to check if it was successful.
344 bool nfs_client_init_is_complete(const struct nfs_client *clp)
346 return clp->cl_cons_state <= NFS_CS_READY;
348 EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
351 * Return 0 if @clp was successfully initialized, -errno otherwise.
353 * This must be called *after* nfs_client_init_is_complete() returns true,
354 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
356 int nfs_client_init_status(const struct nfs_client *clp)
358 /* called without checking nfs_client_init_is_complete */
359 if (clp->cl_cons_state > NFS_CS_READY) {
363 return clp->cl_cons_state;
365 EXPORT_SYMBOL_GPL(nfs_client_init_status);
367 int nfs_wait_client_init_complete(const struct nfs_client *clp)
369 return wait_event_killable(nfs_client_active_wq,
370 nfs_client_init_is_complete(clp));
372 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
375 * Found an existing client. Make sure it's ready before returning.
377 static struct nfs_client *
378 nfs_found_client(const struct nfs_client_initdata *cl_init,
379 struct nfs_client *clp)
383 error = nfs_wait_client_init_complete(clp);
386 return ERR_PTR(-ERESTARTSYS);
389 if (clp->cl_cons_state < NFS_CS_READY) {
390 error = clp->cl_cons_state;
392 return ERR_PTR(error);
400 * Look up a client by IP address and protocol version
401 * - creates a new record if one doesn't yet exist
403 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
405 struct nfs_client *clp, *new = NULL;
406 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
407 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
409 if (cl_init->hostname == NULL) {
411 return ERR_PTR(-EINVAL);
414 /* see if the client already exists */
416 spin_lock(&nn->nfs_client_lock);
418 clp = nfs_match_client(cl_init);
420 spin_unlock(&nn->nfs_client_lock);
422 new->rpc_ops->free_client(new);
425 return nfs_found_client(cl_init, clp);
428 list_add_tail(&new->cl_share_link,
429 &nn->nfs_client_list);
430 spin_unlock(&nn->nfs_client_lock);
431 return rpc_ops->init_client(new, cl_init);
434 spin_unlock(&nn->nfs_client_lock);
436 new = rpc_ops->alloc_client(cl_init);
437 } while (!IS_ERR(new));
441 EXPORT_SYMBOL_GPL(nfs_get_client);
444 * Mark a server as ready or failed
446 void nfs_mark_client_ready(struct nfs_client *clp, int state)
449 clp->cl_cons_state = state;
450 wake_up_all(&nfs_client_active_wq);
452 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
455 * Initialise the timeout values for a connection
457 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
458 int timeo, int retrans)
460 to->to_initval = timeo * HZ / 10;
461 to->to_retries = retrans;
464 case XPRT_TRANSPORT_TCP:
465 case XPRT_TRANSPORT_RDMA:
466 if (retrans == NFS_UNSPEC_RETRANS)
467 to->to_retries = NFS_DEF_TCP_RETRANS;
468 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
469 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
470 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
471 to->to_initval = NFS_MAX_TCP_TIMEOUT;
472 to->to_increment = to->to_initval;
473 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
474 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
475 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
476 if (to->to_maxval < to->to_initval)
477 to->to_maxval = to->to_initval;
478 to->to_exponential = 0;
480 case XPRT_TRANSPORT_UDP:
481 if (retrans == NFS_UNSPEC_RETRANS)
482 to->to_retries = NFS_DEF_UDP_RETRANS;
483 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
484 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
485 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
486 to->to_initval = NFS_MAX_UDP_TIMEOUT;
487 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
488 to->to_exponential = 1;
494 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
497 * Create an RPC client handle
499 int nfs_create_rpc_client(struct nfs_client *clp,
500 const struct nfs_client_initdata *cl_init,
501 rpc_authflavor_t flavor)
503 struct rpc_clnt *clnt = NULL;
504 struct rpc_create_args args = {
506 .protocol = clp->cl_proto,
507 .nconnect = clp->cl_nconnect,
508 .address = (struct sockaddr *)&clp->cl_addr,
509 .addrsize = clp->cl_addrlen,
510 .timeout = cl_init->timeparms,
511 .servername = clp->cl_hostname,
512 .nodename = cl_init->nodename,
513 .program = &nfs_program,
514 .version = clp->rpc_ops->version,
515 .authflavor = flavor,
516 .cred = cl_init->cred,
519 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
520 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
521 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
522 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
523 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
524 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
525 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
526 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
527 if (test_bit(NFS_CS_NOPING, &clp->cl_flags))
528 args.flags |= RPC_CLNT_CREATE_NOPING;
529 if (test_bit(NFS_CS_REUSEPORT, &clp->cl_flags))
530 args.flags |= RPC_CLNT_CREATE_REUSEPORT;
532 if (!IS_ERR(clp->cl_rpcclient))
535 clnt = rpc_create(&args);
537 dprintk("%s: cannot create RPC client. Error = %ld\n",
538 __func__, PTR_ERR(clnt));
539 return PTR_ERR(clnt);
542 clnt->cl_principal = clp->cl_principal;
543 clp->cl_rpcclient = clnt;
544 clnt->cl_max_connect = clp->cl_max_connect;
547 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
550 * Version 2 or 3 client destruction
552 static void nfs_destroy_server(struct nfs_server *server)
554 if (server->nlm_host)
555 nlmclnt_done(server->nlm_host);
559 * Version 2 or 3 lockd setup
561 static int nfs_start_lockd(struct nfs_server *server)
563 struct nlm_host *host;
564 struct nfs_client *clp = server->nfs_client;
565 struct nlmclnt_initdata nlm_init = {
566 .hostname = clp->cl_hostname,
567 .address = (struct sockaddr *)&clp->cl_addr,
568 .addrlen = clp->cl_addrlen,
569 .nfs_version = clp->rpc_ops->version,
570 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
573 .nlmclnt_ops = clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
574 .cred = server->cred,
577 if (nlm_init.nfs_version > 3)
579 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
580 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
583 switch (clp->cl_proto) {
585 nlm_init.protocol = IPPROTO_TCP;
587 #ifndef CONFIG_NFS_DISABLE_UDP_SUPPORT
588 case XPRT_TRANSPORT_UDP:
589 nlm_init.protocol = IPPROTO_UDP;
593 host = nlmclnt_init(&nlm_init);
595 return PTR_ERR(host);
597 server->nlm_host = host;
598 server->destroy = nfs_destroy_server;
603 * Create a general RPC client
605 int nfs_init_server_rpcclient(struct nfs_server *server,
606 const struct rpc_timeout *timeo,
607 rpc_authflavor_t pseudoflavour)
609 struct nfs_client *clp = server->nfs_client;
611 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
613 if (IS_ERR(server->client)) {
614 dprintk("%s: couldn't create rpc_client!\n", __func__);
615 return PTR_ERR(server->client);
618 memcpy(&server->client->cl_timeout_default,
620 sizeof(server->client->cl_timeout_default));
621 server->client->cl_timeout = &server->client->cl_timeout_default;
622 server->client->cl_softrtry = 0;
623 if (server->flags & NFS_MOUNT_SOFTERR)
624 server->client->cl_softerr = 1;
625 if (server->flags & NFS_MOUNT_SOFT)
626 server->client->cl_softrtry = 1;
630 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
633 * nfs_init_client - Initialise an NFS2 or NFS3 client
635 * @clp: nfs_client to initialise
636 * @cl_init: Initialisation parameters
638 * Returns pointer to an NFS client, or an ERR_PTR value.
640 struct nfs_client *nfs_init_client(struct nfs_client *clp,
641 const struct nfs_client_initdata *cl_init)
645 /* the client is already initialised */
646 if (clp->cl_cons_state == NFS_CS_READY)
650 * Create a client RPC handle for doing FSSTAT with UNIX auth only
651 * - RFC 2623, sec 2.3.2
653 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
654 nfs_mark_client_ready(clp, error == 0 ? NFS_CS_READY : error);
657 clp = ERR_PTR(error);
661 EXPORT_SYMBOL_GPL(nfs_init_client);
664 * Create a version 2 or 3 client
666 static int nfs_init_server(struct nfs_server *server,
667 const struct fs_context *fc)
669 const struct nfs_fs_context *ctx = nfs_fc2context(fc);
670 struct rpc_timeout timeparms;
671 struct nfs_client_initdata cl_init = {
672 .hostname = ctx->nfs_server.hostname,
673 .addr = (const struct sockaddr *)&ctx->nfs_server.address,
674 .addrlen = ctx->nfs_server.addrlen,
675 .nfs_mod = ctx->nfs_mod,
676 .proto = ctx->nfs_server.protocol,
678 .timeparms = &timeparms,
679 .cred = server->cred,
680 .nconnect = ctx->nfs_server.nconnect,
681 .init_flags = (1UL << NFS_CS_REUSEPORT),
683 struct nfs_client *clp;
686 nfs_init_timeout_values(&timeparms, ctx->nfs_server.protocol,
687 ctx->timeo, ctx->retrans);
688 if (ctx->flags & NFS_MOUNT_NORESVPORT)
689 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
691 /* Allocate or find a client reference we can use */
692 clp = nfs_get_client(&cl_init);
696 server->nfs_client = clp;
698 /* Initialise the client representation from the mount data */
699 server->flags = ctx->flags;
700 server->options = ctx->options;
701 server->caps |= NFS_CAP_HARDLINKS | NFS_CAP_SYMLINKS;
703 switch (clp->rpc_ops->version) {
705 server->fattr_valid = NFS_ATTR_FATTR_V2;
708 server->fattr_valid = NFS_ATTR_FATTR_V3;
711 server->fattr_valid = NFS_ATTR_FATTR_V4;
715 server->rsize = nfs_block_size(ctx->rsize, NULL);
717 server->wsize = nfs_block_size(ctx->wsize, NULL);
719 server->acregmin = ctx->acregmin * HZ;
720 server->acregmax = ctx->acregmax * HZ;
721 server->acdirmin = ctx->acdirmin * HZ;
722 server->acdirmax = ctx->acdirmax * HZ;
724 /* Start lockd here, before we might error out */
725 error = nfs_start_lockd(server);
729 server->port = ctx->nfs_server.port;
730 server->auth_info = ctx->auth_info;
732 error = nfs_init_server_rpcclient(server, &timeparms,
733 ctx->selected_flavor);
737 /* Preserve the values of mount_server-related mount options */
738 if (ctx->mount_server.addrlen) {
739 memcpy(&server->mountd_address, &ctx->mount_server.address,
740 ctx->mount_server.addrlen);
741 server->mountd_addrlen = ctx->mount_server.addrlen;
743 server->mountd_version = ctx->mount_server.version;
744 server->mountd_port = ctx->mount_server.port;
745 server->mountd_protocol = ctx->mount_server.protocol;
747 server->namelen = ctx->namlen;
751 server->nfs_client = NULL;
757 * Load up the server record from information gained in an fsinfo record
759 static void nfs_server_set_fsinfo(struct nfs_server *server,
760 struct nfs_fsinfo *fsinfo)
762 unsigned long max_rpc_payload, raw_max_rpc_payload;
764 /* Work out a lot of parameters */
765 if (server->rsize == 0)
766 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
767 if (server->wsize == 0)
768 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
770 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
771 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
772 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
773 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
775 raw_max_rpc_payload = rpc_max_payload(server->client);
776 max_rpc_payload = nfs_block_size(raw_max_rpc_payload, NULL);
778 if (server->rsize > max_rpc_payload)
779 server->rsize = max_rpc_payload;
780 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
781 server->rsize = NFS_MAX_FILE_IO_SIZE;
782 server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
784 if (server->wsize > max_rpc_payload)
785 server->wsize = max_rpc_payload;
786 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
787 server->wsize = NFS_MAX_FILE_IO_SIZE;
788 server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
790 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
792 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
793 if (server->dtsize > NFS_MAX_FILE_IO_SIZE)
794 server->dtsize = NFS_MAX_FILE_IO_SIZE;
795 if (server->dtsize > server->rsize)
796 server->dtsize = server->rsize;
798 if (server->flags & NFS_MOUNT_NOAC) {
799 server->acregmin = server->acregmax = 0;
800 server->acdirmin = server->acdirmax = 0;
803 server->maxfilesize = fsinfo->maxfilesize;
805 server->time_delta = fsinfo->time_delta;
806 server->change_attr_type = fsinfo->change_attr_type;
808 server->clone_blksize = fsinfo->clone_blksize;
809 /* We're airborne Set socket buffersize */
810 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
812 #ifdef CONFIG_NFS_V4_2
814 * Defaults until limited by the session parameters.
816 server->gxasize = min_t(unsigned int, raw_max_rpc_payload,
818 server->sxasize = min_t(unsigned int, raw_max_rpc_payload,
820 server->lxasize = min_t(unsigned int, raw_max_rpc_payload,
821 nfs42_listxattr_xdrsize(XATTR_LIST_MAX));
823 if (fsinfo->xattr_support)
824 server->caps |= NFS_CAP_XATTR;
829 * Probe filesystem information, including the FSID on v2/v3
831 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
833 struct nfs_fsinfo fsinfo;
834 struct nfs_client *clp = server->nfs_client;
837 if (clp->rpc_ops->set_capabilities != NULL) {
838 error = clp->rpc_ops->set_capabilities(server, mntfh);
843 fsinfo.fattr = fattr;
844 fsinfo.nlayouttypes = 0;
845 memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
846 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
850 nfs_server_set_fsinfo(server, &fsinfo);
852 /* Get some general file system info */
853 if (server->namelen == 0) {
854 struct nfs_pathconf pathinfo;
856 pathinfo.fattr = fattr;
857 nfs_fattr_init(fattr);
859 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
860 server->namelen = pathinfo.max_namelen;
863 if (clp->rpc_ops->discover_trunking != NULL &&
864 (server->caps & NFS_CAP_FS_LOCATIONS)) {
865 error = clp->rpc_ops->discover_trunking(server, mntfh);
872 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
875 * Copy useful information when duplicating a server record
877 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
879 target->flags = source->flags;
880 target->rsize = source->rsize;
881 target->wsize = source->wsize;
882 target->acregmin = source->acregmin;
883 target->acregmax = source->acregmax;
884 target->acdirmin = source->acdirmin;
885 target->acdirmax = source->acdirmax;
886 target->caps = source->caps;
887 target->options = source->options;
888 target->auth_info = source->auth_info;
889 target->port = source->port;
891 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
893 void nfs_server_insert_lists(struct nfs_server *server)
895 struct nfs_client *clp = server->nfs_client;
896 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
898 spin_lock(&nn->nfs_client_lock);
899 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
900 list_add_tail(&server->master_link, &nn->nfs_volume_list);
901 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
902 spin_unlock(&nn->nfs_client_lock);
905 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
907 void nfs_server_remove_lists(struct nfs_server *server)
909 struct nfs_client *clp = server->nfs_client;
914 nn = net_generic(clp->cl_net, nfs_net_id);
915 spin_lock(&nn->nfs_client_lock);
916 list_del_rcu(&server->client_link);
917 if (list_empty(&clp->cl_superblocks))
918 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
919 list_del(&server->master_link);
920 spin_unlock(&nn->nfs_client_lock);
924 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
927 * Allocate and initialise a server record
929 struct nfs_server *nfs_alloc_server(void)
931 struct nfs_server *server;
933 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
937 server->client = server->client_acl = ERR_PTR(-EINVAL);
939 /* Zero out the NFS state stuff */
940 INIT_LIST_HEAD(&server->client_link);
941 INIT_LIST_HEAD(&server->master_link);
942 INIT_LIST_HEAD(&server->delegations);
943 INIT_LIST_HEAD(&server->layouts);
944 INIT_LIST_HEAD(&server->state_owners_lru);
945 INIT_LIST_HEAD(&server->ss_copies);
947 atomic_set(&server->active, 0);
949 server->io_stats = nfs_alloc_iostats();
950 if (!server->io_stats) {
955 server->change_attr_type = NFS4_CHANGE_TYPE_IS_UNDEFINED;
957 ida_init(&server->openowner_id);
958 ida_init(&server->lockowner_id);
959 pnfs_init_server(server);
960 rpc_init_wait_queue(&server->uoc_rpcwaitq, "NFS UOC");
964 EXPORT_SYMBOL_GPL(nfs_alloc_server);
967 * Free up a server record
969 void nfs_free_server(struct nfs_server *server)
971 nfs_server_remove_lists(server);
973 if (server->destroy != NULL)
974 server->destroy(server);
976 if (!IS_ERR(server->client_acl))
977 rpc_shutdown_client(server->client_acl);
978 if (!IS_ERR(server->client))
979 rpc_shutdown_client(server->client);
981 nfs_put_client(server->nfs_client);
983 ida_destroy(&server->lockowner_id);
984 ida_destroy(&server->openowner_id);
985 nfs_free_iostats(server->io_stats);
986 put_cred(server->cred);
988 nfs_release_automount_timer();
990 EXPORT_SYMBOL_GPL(nfs_free_server);
993 * Create a version 2 or 3 volume record
994 * - keyed on server and FSID
996 struct nfs_server *nfs_create_server(struct fs_context *fc)
998 struct nfs_fs_context *ctx = nfs_fc2context(fc);
999 struct nfs_server *server;
1000 struct nfs_fattr *fattr;
1003 server = nfs_alloc_server();
1005 return ERR_PTR(-ENOMEM);
1007 server->cred = get_cred(fc->cred);
1010 fattr = nfs_alloc_fattr();
1014 /* Get a client representation */
1015 error = nfs_init_server(server, fc);
1019 /* Probe the root fh to retrieve its FSID */
1020 error = nfs_probe_fsinfo(server, ctx->mntfh, fattr);
1023 if (server->nfs_client->rpc_ops->version == 3) {
1024 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1025 server->namelen = NFS3_MAXNAMLEN;
1026 if (!(ctx->flags & NFS_MOUNT_NORDIRPLUS))
1027 server->caps |= NFS_CAP_READDIRPLUS;
1029 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1030 server->namelen = NFS2_MAXNAMLEN;
1033 if (!(fattr->valid & NFS_ATTR_FATTR)) {
1034 error = ctx->nfs_mod->rpc_ops->getattr(server, ctx->mntfh,
1037 dprintk("nfs_create_server: getattr error = %d\n", -error);
1041 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1043 dprintk("Server FSID: %llx:%llx\n",
1044 (unsigned long long) server->fsid.major,
1045 (unsigned long long) server->fsid.minor);
1047 nfs_server_insert_lists(server);
1048 server->mount_time = jiffies;
1049 nfs_free_fattr(fattr);
1053 nfs_free_fattr(fattr);
1054 nfs_free_server(server);
1055 return ERR_PTR(error);
1057 EXPORT_SYMBOL_GPL(nfs_create_server);
1060 * Clone an NFS2, NFS3 or NFS4 server record
1062 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1064 struct nfs_fattr *fattr,
1065 rpc_authflavor_t flavor)
1067 struct nfs_server *server;
1068 struct nfs_fattr *fattr_fsinfo;
1071 server = nfs_alloc_server();
1073 return ERR_PTR(-ENOMEM);
1075 server->cred = get_cred(source->cred);
1078 fattr_fsinfo = nfs_alloc_fattr();
1079 if (fattr_fsinfo == NULL)
1080 goto out_free_server;
1082 /* Copy data from the source */
1083 server->nfs_client = source->nfs_client;
1084 server->destroy = source->destroy;
1085 refcount_inc(&server->nfs_client->cl_count);
1086 nfs_server_copy_userdata(server, source);
1088 server->fsid = fattr->fsid;
1090 error = nfs_init_server_rpcclient(server,
1091 source->client->cl_timeout,
1094 goto out_free_server;
1096 /* probe the filesystem info for this server filesystem */
1097 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1099 goto out_free_server;
1101 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1102 server->namelen = NFS4_MAXNAMLEN;
1104 error = nfs_start_lockd(server);
1106 goto out_free_server;
1108 nfs_server_insert_lists(server);
1109 server->mount_time = jiffies;
1111 nfs_free_fattr(fattr_fsinfo);
1115 nfs_free_fattr(fattr_fsinfo);
1116 nfs_free_server(server);
1117 return ERR_PTR(error);
1119 EXPORT_SYMBOL_GPL(nfs_clone_server);
1121 void nfs_clients_init(struct net *net)
1123 struct nfs_net *nn = net_generic(net, nfs_net_id);
1125 INIT_LIST_HEAD(&nn->nfs_client_list);
1126 INIT_LIST_HEAD(&nn->nfs_volume_list);
1127 #if IS_ENABLED(CONFIG_NFS_V4)
1128 idr_init(&nn->cb_ident_idr);
1130 spin_lock_init(&nn->nfs_client_lock);
1131 nn->boot_time = ktime_get_real();
1133 nfs_netns_sysfs_setup(nn, net);
1136 void nfs_clients_exit(struct net *net)
1138 struct nfs_net *nn = net_generic(net, nfs_net_id);
1140 nfs_netns_sysfs_destroy(nn);
1141 nfs_cleanup_cb_ident_idr(net);
1142 WARN_ON_ONCE(!list_empty(&nn->nfs_client_list));
1143 WARN_ON_ONCE(!list_empty(&nn->nfs_volume_list));
1146 #ifdef CONFIG_PROC_FS
1147 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1148 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1149 static void nfs_server_list_stop(struct seq_file *p, void *v);
1150 static int nfs_server_list_show(struct seq_file *m, void *v);
1152 static const struct seq_operations nfs_server_list_ops = {
1153 .start = nfs_server_list_start,
1154 .next = nfs_server_list_next,
1155 .stop = nfs_server_list_stop,
1156 .show = nfs_server_list_show,
1159 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1160 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1161 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1162 static int nfs_volume_list_show(struct seq_file *m, void *v);
1164 static const struct seq_operations nfs_volume_list_ops = {
1165 .start = nfs_volume_list_start,
1166 .next = nfs_volume_list_next,
1167 .stop = nfs_volume_list_stop,
1168 .show = nfs_volume_list_show,
1172 * set up the iterator to start reading from the server list and return the first item
1174 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1175 __acquires(&nn->nfs_client_lock)
1177 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1179 /* lock the list against modification */
1180 spin_lock(&nn->nfs_client_lock);
1181 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1185 * move to next server
1187 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1189 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1191 return seq_list_next(v, &nn->nfs_client_list, pos);
1195 * clean up after reading from the transports list
1197 static void nfs_server_list_stop(struct seq_file *p, void *v)
1198 __releases(&nn->nfs_client_lock)
1200 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1202 spin_unlock(&nn->nfs_client_lock);
1206 * display a header line followed by a load of call lines
1208 static int nfs_server_list_show(struct seq_file *m, void *v)
1210 struct nfs_client *clp;
1211 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1213 /* display header on line 1 */
1214 if (v == &nn->nfs_client_list) {
1215 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1219 /* display one transport per line on subsequent lines */
1220 clp = list_entry(v, struct nfs_client, cl_share_link);
1222 /* Check if the client is initialized */
1223 if (clp->cl_cons_state != NFS_CS_READY)
1227 seq_printf(m, "v%u %s %s %3d %s\n",
1228 clp->rpc_ops->version,
1229 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1230 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1231 refcount_read(&clp->cl_count),
1239 * set up the iterator to start reading from the volume list and return the first item
1241 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1242 __acquires(&nn->nfs_client_lock)
1244 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1246 /* lock the list against modification */
1247 spin_lock(&nn->nfs_client_lock);
1248 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1252 * move to next volume
1254 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1256 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1258 return seq_list_next(v, &nn->nfs_volume_list, pos);
1262 * clean up after reading from the transports list
1264 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1265 __releases(&nn->nfs_client_lock)
1267 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1269 spin_unlock(&nn->nfs_client_lock);
1273 * display a header line followed by a load of call lines
1275 static int nfs_volume_list_show(struct seq_file *m, void *v)
1277 struct nfs_server *server;
1278 struct nfs_client *clp;
1279 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1280 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1281 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1283 /* display header on line 1 */
1284 if (v == &nn->nfs_volume_list) {
1285 seq_puts(m, "NV SERVER PORT DEV FSID"
1289 /* display one transport per line on subsequent lines */
1290 server = list_entry(v, struct nfs_server, master_link);
1291 clp = server->nfs_client;
1293 snprintf(dev, sizeof(dev), "%u:%u",
1294 MAJOR(server->s_dev), MINOR(server->s_dev));
1296 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1297 (unsigned long long) server->fsid.major,
1298 (unsigned long long) server->fsid.minor);
1301 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1302 clp->rpc_ops->version,
1303 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1304 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1307 nfs_server_fscache_state(server));
1313 int nfs_fs_proc_net_init(struct net *net)
1315 struct nfs_net *nn = net_generic(net, nfs_net_id);
1316 struct proc_dir_entry *p;
1318 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1319 if (!nn->proc_nfsfs)
1322 /* a file of servers with which we're dealing */
1323 p = proc_create_net("servers", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1324 &nfs_server_list_ops, sizeof(struct seq_net_private));
1328 /* a file of volumes that we have mounted */
1329 p = proc_create_net("volumes", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1330 &nfs_volume_list_ops, sizeof(struct seq_net_private));
1336 remove_proc_subtree("nfsfs", net->proc_net);
1341 void nfs_fs_proc_net_exit(struct net *net)
1343 remove_proc_subtree("nfsfs", net->proc_net);
1347 * initialise the /proc/fs/nfsfs/ directory
1349 int __init nfs_fs_proc_init(void)
1351 if (!proc_mkdir("fs/nfsfs", NULL))
1354 /* a file of servers with which we're dealing */
1355 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1358 /* a file of volumes that we have mounted */
1359 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1364 remove_proc_subtree("fs/nfsfs", NULL);
1370 * clean up the /proc/fs/nfsfs/ directory
1372 void nfs_fs_proc_exit(void)
1374 remove_proc_subtree("fs/nfsfs", NULL);
1377 #endif /* CONFIG_PROC_FS */