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"
54 #define NFSDBG_FACILITY NFSDBG_CLIENT
56 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
57 static DEFINE_SPINLOCK(nfs_version_lock);
58 static DEFINE_MUTEX(nfs_version_mutex);
59 static LIST_HEAD(nfs_versions);
64 static const struct rpc_version *nfs_version[5] = {
70 const struct rpc_program nfs_program = {
72 .number = NFS_PROGRAM,
73 .nrvers = ARRAY_SIZE(nfs_version),
74 .version = nfs_version,
75 .stats = &nfs_rpcstat,
76 .pipe_dir_name = NFS_PIPE_DIRNAME,
79 struct rpc_stat nfs_rpcstat = {
80 .program = &nfs_program
83 static struct nfs_subversion *find_nfs_version(unsigned int version)
85 struct nfs_subversion *nfs;
86 spin_lock(&nfs_version_lock);
88 list_for_each_entry(nfs, &nfs_versions, list) {
89 if (nfs->rpc_ops->version == version) {
90 spin_unlock(&nfs_version_lock);
95 spin_unlock(&nfs_version_lock);
96 return ERR_PTR(-EPROTONOSUPPORT);
99 struct nfs_subversion *get_nfs_version(unsigned int version)
101 struct nfs_subversion *nfs = find_nfs_version(version);
104 mutex_lock(&nfs_version_mutex);
105 request_module("nfsv%d", version);
106 nfs = find_nfs_version(version);
107 mutex_unlock(&nfs_version_mutex);
110 if (!IS_ERR(nfs) && !try_module_get(nfs->owner))
111 return ERR_PTR(-EAGAIN);
115 void put_nfs_version(struct nfs_subversion *nfs)
117 module_put(nfs->owner);
120 void register_nfs_version(struct nfs_subversion *nfs)
122 spin_lock(&nfs_version_lock);
124 list_add(&nfs->list, &nfs_versions);
125 nfs_version[nfs->rpc_ops->version] = nfs->rpc_vers;
127 spin_unlock(&nfs_version_lock);
129 EXPORT_SYMBOL_GPL(register_nfs_version);
131 void unregister_nfs_version(struct nfs_subversion *nfs)
133 spin_lock(&nfs_version_lock);
135 nfs_version[nfs->rpc_ops->version] = NULL;
136 list_del(&nfs->list);
138 spin_unlock(&nfs_version_lock);
140 EXPORT_SYMBOL_GPL(unregister_nfs_version);
143 * Allocate a shared client record
145 * Since these are allocated/deallocated very rarely, we don't
146 * bother putting them in a slab cache...
148 struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
150 struct nfs_client *clp;
153 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
156 clp->cl_nfs_mod = cl_init->nfs_mod;
157 if (!try_module_get(clp->cl_nfs_mod->owner))
160 clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
162 refcount_set(&clp->cl_count, 1);
163 clp->cl_cons_state = NFS_CS_INITING;
165 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
166 clp->cl_addrlen = cl_init->addrlen;
168 if (cl_init->hostname) {
170 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
171 if (!clp->cl_hostname)
175 INIT_LIST_HEAD(&clp->cl_superblocks);
176 clp->cl_rpcclient = ERR_PTR(-EINVAL);
178 clp->cl_proto = cl_init->proto;
179 clp->cl_nconnect = cl_init->nconnect;
180 clp->cl_net = get_net(cl_init->net);
182 clp->cl_principal = "*";
183 nfs_fscache_get_client_cookie(clp);
188 put_nfs_version(clp->cl_nfs_mod);
194 EXPORT_SYMBOL_GPL(nfs_alloc_client);
196 #if IS_ENABLED(CONFIG_NFS_V4)
197 static void nfs_cleanup_cb_ident_idr(struct net *net)
199 struct nfs_net *nn = net_generic(net, nfs_net_id);
201 idr_destroy(&nn->cb_ident_idr);
204 /* nfs_client_lock held */
205 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
207 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
209 if (clp->cl_cb_ident)
210 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
213 static void pnfs_init_server(struct nfs_server *server)
215 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
219 static void nfs_cleanup_cb_ident_idr(struct net *net)
223 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
227 static void pnfs_init_server(struct nfs_server *server)
231 #endif /* CONFIG_NFS_V4 */
234 * Destroy a shared client record
236 void nfs_free_client(struct nfs_client *clp)
238 nfs_fscache_release_client_cookie(clp);
240 /* -EIO all pending I/O */
241 if (!IS_ERR(clp->cl_rpcclient))
242 rpc_shutdown_client(clp->cl_rpcclient);
244 put_net(clp->cl_net);
245 put_nfs_version(clp->cl_nfs_mod);
246 kfree(clp->cl_hostname);
247 kfree(clp->cl_acceptor);
250 EXPORT_SYMBOL_GPL(nfs_free_client);
253 * Release a reference to a shared client record
255 void nfs_put_client(struct nfs_client *clp)
262 nn = net_generic(clp->cl_net, nfs_net_id);
264 if (refcount_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
265 list_del(&clp->cl_share_link);
266 nfs_cb_idr_remove_locked(clp);
267 spin_unlock(&nn->nfs_client_lock);
269 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
271 clp->rpc_ops->free_client(clp);
274 EXPORT_SYMBOL_GPL(nfs_put_client);
277 * Find an nfs_client on the list that matches the initialisation data
280 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
282 struct nfs_client *clp;
283 const struct sockaddr *sap = data->addr;
284 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
288 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
289 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
290 /* Don't match clients that failed to initialise properly */
291 if (clp->cl_cons_state < 0)
294 /* If a client is still initializing then we need to wait */
295 if (clp->cl_cons_state > NFS_CS_READY) {
296 refcount_inc(&clp->cl_count);
297 spin_unlock(&nn->nfs_client_lock);
298 error = nfs_wait_client_init_complete(clp);
300 spin_lock(&nn->nfs_client_lock);
302 return ERR_PTR(error);
306 /* Different NFS versions cannot share the same nfs_client */
307 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
310 if (clp->cl_proto != data->proto)
312 /* Match nfsv4 minorversion */
313 if (clp->cl_minorversion != data->minorversion)
315 /* Match the full socket address */
316 if (!rpc_cmp_addr_port(sap, clap))
317 /* Match all xprt_switch full socket addresses */
318 if (IS_ERR(clp->cl_rpcclient) ||
319 !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
323 refcount_inc(&clp->cl_count);
330 * Return true if @clp is done initializing, false if still working on it.
332 * Use nfs_client_init_status to check if it was successful.
334 bool nfs_client_init_is_complete(const struct nfs_client *clp)
336 return clp->cl_cons_state <= NFS_CS_READY;
338 EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
341 * Return 0 if @clp was successfully initialized, -errno otherwise.
343 * This must be called *after* nfs_client_init_is_complete() returns true,
344 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
346 int nfs_client_init_status(const struct nfs_client *clp)
348 /* called without checking nfs_client_init_is_complete */
349 if (clp->cl_cons_state > NFS_CS_READY) {
353 return clp->cl_cons_state;
355 EXPORT_SYMBOL_GPL(nfs_client_init_status);
357 int nfs_wait_client_init_complete(const struct nfs_client *clp)
359 return wait_event_killable(nfs_client_active_wq,
360 nfs_client_init_is_complete(clp));
362 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
365 * Found an existing client. Make sure it's ready before returning.
367 static struct nfs_client *
368 nfs_found_client(const struct nfs_client_initdata *cl_init,
369 struct nfs_client *clp)
373 error = nfs_wait_client_init_complete(clp);
376 return ERR_PTR(-ERESTARTSYS);
379 if (clp->cl_cons_state < NFS_CS_READY) {
380 error = clp->cl_cons_state;
382 return ERR_PTR(error);
390 * Look up a client by IP address and protocol version
391 * - creates a new record if one doesn't yet exist
393 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
395 struct nfs_client *clp, *new = NULL;
396 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
397 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
399 if (cl_init->hostname == NULL) {
404 /* see if the client already exists */
406 spin_lock(&nn->nfs_client_lock);
408 clp = nfs_match_client(cl_init);
410 spin_unlock(&nn->nfs_client_lock);
412 new->rpc_ops->free_client(new);
415 return nfs_found_client(cl_init, clp);
418 list_add_tail(&new->cl_share_link,
419 &nn->nfs_client_list);
420 spin_unlock(&nn->nfs_client_lock);
421 new->cl_flags = cl_init->init_flags;
422 return rpc_ops->init_client(new, cl_init);
425 spin_unlock(&nn->nfs_client_lock);
427 new = rpc_ops->alloc_client(cl_init);
428 } while (!IS_ERR(new));
432 EXPORT_SYMBOL_GPL(nfs_get_client);
435 * Mark a server as ready or failed
437 void nfs_mark_client_ready(struct nfs_client *clp, int state)
440 clp->cl_cons_state = state;
441 wake_up_all(&nfs_client_active_wq);
443 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
446 * Initialise the timeout values for a connection
448 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
449 int timeo, int retrans)
451 to->to_initval = timeo * HZ / 10;
452 to->to_retries = retrans;
455 case XPRT_TRANSPORT_TCP:
456 case XPRT_TRANSPORT_RDMA:
457 if (retrans == NFS_UNSPEC_RETRANS)
458 to->to_retries = NFS_DEF_TCP_RETRANS;
459 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
460 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
461 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
462 to->to_initval = NFS_MAX_TCP_TIMEOUT;
463 to->to_increment = to->to_initval;
464 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
465 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
466 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
467 if (to->to_maxval < to->to_initval)
468 to->to_maxval = to->to_initval;
469 to->to_exponential = 0;
471 case XPRT_TRANSPORT_UDP:
472 if (retrans == NFS_UNSPEC_RETRANS)
473 to->to_retries = NFS_DEF_UDP_RETRANS;
474 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
475 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
476 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
477 to->to_initval = NFS_MAX_UDP_TIMEOUT;
478 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
479 to->to_exponential = 1;
485 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
488 * Create an RPC client handle
490 int nfs_create_rpc_client(struct nfs_client *clp,
491 const struct nfs_client_initdata *cl_init,
492 rpc_authflavor_t flavor)
494 struct rpc_clnt *clnt = NULL;
495 struct rpc_create_args args = {
497 .protocol = clp->cl_proto,
498 .nconnect = clp->cl_nconnect,
499 .address = (struct sockaddr *)&clp->cl_addr,
500 .addrsize = clp->cl_addrlen,
501 .timeout = cl_init->timeparms,
502 .servername = clp->cl_hostname,
503 .nodename = cl_init->nodename,
504 .program = &nfs_program,
505 .version = clp->rpc_ops->version,
506 .authflavor = flavor,
507 .cred = cl_init->cred,
510 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
511 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
512 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
513 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
514 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
515 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
516 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
517 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
518 if (test_bit(NFS_CS_NOPING, &clp->cl_flags))
519 args.flags |= RPC_CLNT_CREATE_NOPING;
521 if (!IS_ERR(clp->cl_rpcclient))
524 clnt = rpc_create(&args);
526 dprintk("%s: cannot create RPC client. Error = %ld\n",
527 __func__, PTR_ERR(clnt));
528 return PTR_ERR(clnt);
531 clnt->cl_principal = clp->cl_principal;
532 clp->cl_rpcclient = clnt;
535 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
538 * Version 2 or 3 client destruction
540 static void nfs_destroy_server(struct nfs_server *server)
542 if (server->nlm_host)
543 nlmclnt_done(server->nlm_host);
547 * Version 2 or 3 lockd setup
549 static int nfs_start_lockd(struct nfs_server *server)
551 struct nlm_host *host;
552 struct nfs_client *clp = server->nfs_client;
553 struct nlmclnt_initdata nlm_init = {
554 .hostname = clp->cl_hostname,
555 .address = (struct sockaddr *)&clp->cl_addr,
556 .addrlen = clp->cl_addrlen,
557 .nfs_version = clp->rpc_ops->version,
558 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
561 .nlmclnt_ops = clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
562 .cred = current_cred(),
565 if (nlm_init.nfs_version > 3)
567 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
568 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
571 switch (clp->cl_proto) {
573 nlm_init.protocol = IPPROTO_TCP;
575 case XPRT_TRANSPORT_UDP:
576 nlm_init.protocol = IPPROTO_UDP;
579 host = nlmclnt_init(&nlm_init);
581 return PTR_ERR(host);
583 server->nlm_host = host;
584 server->destroy = nfs_destroy_server;
589 * Create a general RPC client
591 int nfs_init_server_rpcclient(struct nfs_server *server,
592 const struct rpc_timeout *timeo,
593 rpc_authflavor_t pseudoflavour)
595 struct nfs_client *clp = server->nfs_client;
597 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
599 if (IS_ERR(server->client)) {
600 dprintk("%s: couldn't create rpc_client!\n", __func__);
601 return PTR_ERR(server->client);
604 memcpy(&server->client->cl_timeout_default,
606 sizeof(server->client->cl_timeout_default));
607 server->client->cl_timeout = &server->client->cl_timeout_default;
608 server->client->cl_softrtry = 0;
609 if (server->flags & NFS_MOUNT_SOFTERR)
610 server->client->cl_softerr = 1;
611 if (server->flags & NFS_MOUNT_SOFT)
612 server->client->cl_softrtry = 1;
616 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
619 * nfs_init_client - Initialise an NFS2 or NFS3 client
621 * @clp: nfs_client to initialise
622 * @cl_init: Initialisation parameters
624 * Returns pointer to an NFS client, or an ERR_PTR value.
626 struct nfs_client *nfs_init_client(struct nfs_client *clp,
627 const struct nfs_client_initdata *cl_init)
631 /* the client is already initialised */
632 if (clp->cl_cons_state == NFS_CS_READY)
636 * Create a client RPC handle for doing FSSTAT with UNIX auth only
637 * - RFC 2623, sec 2.3.2
639 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
640 nfs_mark_client_ready(clp, error == 0 ? NFS_CS_READY : error);
643 clp = ERR_PTR(error);
647 EXPORT_SYMBOL_GPL(nfs_init_client);
650 * Create a version 2 or 3 client
652 static int nfs_init_server(struct nfs_server *server,
653 const struct nfs_parsed_mount_data *data,
654 struct nfs_subversion *nfs_mod)
656 struct rpc_timeout timeparms;
657 struct nfs_client_initdata cl_init = {
658 .hostname = data->nfs_server.hostname,
659 .addr = (const struct sockaddr *)&data->nfs_server.address,
660 .addrlen = data->nfs_server.addrlen,
662 .proto = data->nfs_server.protocol,
664 .timeparms = &timeparms,
665 .cred = server->cred,
666 .nconnect = data->nfs_server.nconnect,
668 struct nfs_client *clp;
671 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
672 data->timeo, data->retrans);
673 if (data->flags & NFS_MOUNT_NORESVPORT)
674 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
676 /* Allocate or find a client reference we can use */
677 clp = nfs_get_client(&cl_init);
681 server->nfs_client = clp;
683 /* Initialise the client representation from the mount data */
684 server->flags = data->flags;
685 server->options = data->options;
686 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
687 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
688 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
691 server->rsize = nfs_block_size(data->rsize, NULL);
693 server->wsize = nfs_block_size(data->wsize, NULL);
695 server->acregmin = data->acregmin * HZ;
696 server->acregmax = data->acregmax * HZ;
697 server->acdirmin = data->acdirmin * HZ;
698 server->acdirmax = data->acdirmax * HZ;
700 /* Start lockd here, before we might error out */
701 error = nfs_start_lockd(server);
705 server->port = data->nfs_server.port;
706 server->auth_info = data->auth_info;
708 error = nfs_init_server_rpcclient(server, &timeparms,
709 data->selected_flavor);
713 /* Preserve the values of mount_server-related mount options */
714 if (data->mount_server.addrlen) {
715 memcpy(&server->mountd_address, &data->mount_server.address,
716 data->mount_server.addrlen);
717 server->mountd_addrlen = data->mount_server.addrlen;
719 server->mountd_version = data->mount_server.version;
720 server->mountd_port = data->mount_server.port;
721 server->mountd_protocol = data->mount_server.protocol;
723 server->namelen = data->namlen;
727 server->nfs_client = NULL;
733 * Load up the server record from information gained in an fsinfo record
735 static void nfs_server_set_fsinfo(struct nfs_server *server,
736 struct nfs_fsinfo *fsinfo)
738 unsigned long max_rpc_payload;
740 /* Work out a lot of parameters */
741 if (server->rsize == 0)
742 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
743 if (server->wsize == 0)
744 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
746 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
747 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
748 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
749 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
751 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
752 if (server->rsize > max_rpc_payload)
753 server->rsize = max_rpc_payload;
754 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
755 server->rsize = NFS_MAX_FILE_IO_SIZE;
756 server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
758 if (server->wsize > max_rpc_payload)
759 server->wsize = max_rpc_payload;
760 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
761 server->wsize = NFS_MAX_FILE_IO_SIZE;
762 server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
764 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
766 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
767 if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
768 server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
769 if (server->dtsize > server->rsize)
770 server->dtsize = server->rsize;
772 if (server->flags & NFS_MOUNT_NOAC) {
773 server->acregmin = server->acregmax = 0;
774 server->acdirmin = server->acdirmax = 0;
777 server->maxfilesize = fsinfo->maxfilesize;
779 server->time_delta = fsinfo->time_delta;
781 server->clone_blksize = fsinfo->clone_blksize;
782 /* We're airborne Set socket buffersize */
783 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
787 * Probe filesystem information, including the FSID on v2/v3
789 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
791 struct nfs_fsinfo fsinfo;
792 struct nfs_client *clp = server->nfs_client;
795 if (clp->rpc_ops->set_capabilities != NULL) {
796 error = clp->rpc_ops->set_capabilities(server, mntfh);
801 fsinfo.fattr = fattr;
802 fsinfo.nlayouttypes = 0;
803 memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
804 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
808 nfs_server_set_fsinfo(server, &fsinfo);
810 /* Get some general file system info */
811 if (server->namelen == 0) {
812 struct nfs_pathconf pathinfo;
814 pathinfo.fattr = fattr;
815 nfs_fattr_init(fattr);
817 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
818 server->namelen = pathinfo.max_namelen;
823 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
826 * Copy useful information when duplicating a server record
828 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
830 target->flags = source->flags;
831 target->rsize = source->rsize;
832 target->wsize = source->wsize;
833 target->acregmin = source->acregmin;
834 target->acregmax = source->acregmax;
835 target->acdirmin = source->acdirmin;
836 target->acdirmax = source->acdirmax;
837 target->caps = source->caps;
838 target->options = source->options;
839 target->auth_info = source->auth_info;
840 target->port = source->port;
842 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
844 void nfs_server_insert_lists(struct nfs_server *server)
846 struct nfs_client *clp = server->nfs_client;
847 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
849 spin_lock(&nn->nfs_client_lock);
850 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
851 list_add_tail(&server->master_link, &nn->nfs_volume_list);
852 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
853 spin_unlock(&nn->nfs_client_lock);
856 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
858 void nfs_server_remove_lists(struct nfs_server *server)
860 struct nfs_client *clp = server->nfs_client;
865 nn = net_generic(clp->cl_net, nfs_net_id);
866 spin_lock(&nn->nfs_client_lock);
867 list_del_rcu(&server->client_link);
868 if (list_empty(&clp->cl_superblocks))
869 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
870 list_del(&server->master_link);
871 spin_unlock(&nn->nfs_client_lock);
875 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
878 * Allocate and initialise a server record
880 struct nfs_server *nfs_alloc_server(void)
882 struct nfs_server *server;
884 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
888 server->client = server->client_acl = ERR_PTR(-EINVAL);
890 /* Zero out the NFS state stuff */
891 INIT_LIST_HEAD(&server->client_link);
892 INIT_LIST_HEAD(&server->master_link);
893 INIT_LIST_HEAD(&server->delegations);
894 INIT_LIST_HEAD(&server->layouts);
895 INIT_LIST_HEAD(&server->state_owners_lru);
896 INIT_LIST_HEAD(&server->ss_copies);
898 atomic_set(&server->active, 0);
900 server->io_stats = nfs_alloc_iostats();
901 if (!server->io_stats) {
906 ida_init(&server->openowner_id);
907 ida_init(&server->lockowner_id);
908 pnfs_init_server(server);
909 rpc_init_wait_queue(&server->uoc_rpcwaitq, "NFS UOC");
913 EXPORT_SYMBOL_GPL(nfs_alloc_server);
916 * Free up a server record
918 void nfs_free_server(struct nfs_server *server)
920 nfs_server_remove_lists(server);
922 if (server->destroy != NULL)
923 server->destroy(server);
925 if (!IS_ERR(server->client_acl))
926 rpc_shutdown_client(server->client_acl);
927 if (!IS_ERR(server->client))
928 rpc_shutdown_client(server->client);
930 nfs_put_client(server->nfs_client);
932 ida_destroy(&server->lockowner_id);
933 ida_destroy(&server->openowner_id);
934 nfs_free_iostats(server->io_stats);
935 put_cred(server->cred);
937 nfs_release_automount_timer();
939 EXPORT_SYMBOL_GPL(nfs_free_server);
942 * Create a version 2 or 3 volume record
943 * - keyed on server and FSID
945 struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
946 struct nfs_subversion *nfs_mod)
948 struct nfs_server *server;
949 struct nfs_fattr *fattr;
952 server = nfs_alloc_server();
954 return ERR_PTR(-ENOMEM);
956 server->cred = get_cred(current_cred());
959 fattr = nfs_alloc_fattr();
963 /* Get a client representation */
964 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
968 /* Probe the root fh to retrieve its FSID */
969 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
972 if (server->nfs_client->rpc_ops->version == 3) {
973 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
974 server->namelen = NFS3_MAXNAMLEN;
975 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
976 server->caps |= NFS_CAP_READDIRPLUS;
978 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
979 server->namelen = NFS2_MAXNAMLEN;
982 if (!(fattr->valid & NFS_ATTR_FATTR)) {
983 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh,
986 dprintk("nfs_create_server: getattr error = %d\n", -error);
990 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
992 dprintk("Server FSID: %llx:%llx\n",
993 (unsigned long long) server->fsid.major,
994 (unsigned long long) server->fsid.minor);
996 nfs_server_insert_lists(server);
997 server->mount_time = jiffies;
998 nfs_free_fattr(fattr);
1002 nfs_free_fattr(fattr);
1003 nfs_free_server(server);
1004 return ERR_PTR(error);
1006 EXPORT_SYMBOL_GPL(nfs_create_server);
1009 * Clone an NFS2, NFS3 or NFS4 server record
1011 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1013 struct nfs_fattr *fattr,
1014 rpc_authflavor_t flavor)
1016 struct nfs_server *server;
1017 struct nfs_fattr *fattr_fsinfo;
1020 server = nfs_alloc_server();
1022 return ERR_PTR(-ENOMEM);
1024 server->cred = get_cred(source->cred);
1027 fattr_fsinfo = nfs_alloc_fattr();
1028 if (fattr_fsinfo == NULL)
1029 goto out_free_server;
1031 /* Copy data from the source */
1032 server->nfs_client = source->nfs_client;
1033 server->destroy = source->destroy;
1034 refcount_inc(&server->nfs_client->cl_count);
1035 nfs_server_copy_userdata(server, source);
1037 server->fsid = fattr->fsid;
1039 error = nfs_init_server_rpcclient(server,
1040 source->client->cl_timeout,
1043 goto out_free_server;
1045 /* probe the filesystem info for this server filesystem */
1046 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1048 goto out_free_server;
1050 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1051 server->namelen = NFS4_MAXNAMLEN;
1053 error = nfs_start_lockd(server);
1055 goto out_free_server;
1057 nfs_server_insert_lists(server);
1058 server->mount_time = jiffies;
1060 nfs_free_fattr(fattr_fsinfo);
1064 nfs_free_fattr(fattr_fsinfo);
1065 nfs_free_server(server);
1066 return ERR_PTR(error);
1068 EXPORT_SYMBOL_GPL(nfs_clone_server);
1070 void nfs_clients_init(struct net *net)
1072 struct nfs_net *nn = net_generic(net, nfs_net_id);
1074 INIT_LIST_HEAD(&nn->nfs_client_list);
1075 INIT_LIST_HEAD(&nn->nfs_volume_list);
1076 #if IS_ENABLED(CONFIG_NFS_V4)
1077 idr_init(&nn->cb_ident_idr);
1079 spin_lock_init(&nn->nfs_client_lock);
1080 nn->boot_time = ktime_get_real();
1082 nfs_netns_sysfs_setup(nn, net);
1085 void nfs_clients_exit(struct net *net)
1087 struct nfs_net *nn = net_generic(net, nfs_net_id);
1089 nfs_netns_sysfs_destroy(nn);
1090 nfs_cleanup_cb_ident_idr(net);
1091 WARN_ON_ONCE(!list_empty(&nn->nfs_client_list));
1092 WARN_ON_ONCE(!list_empty(&nn->nfs_volume_list));
1095 #ifdef CONFIG_PROC_FS
1096 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1097 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1098 static void nfs_server_list_stop(struct seq_file *p, void *v);
1099 static int nfs_server_list_show(struct seq_file *m, void *v);
1101 static const struct seq_operations nfs_server_list_ops = {
1102 .start = nfs_server_list_start,
1103 .next = nfs_server_list_next,
1104 .stop = nfs_server_list_stop,
1105 .show = nfs_server_list_show,
1108 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1109 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1110 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1111 static int nfs_volume_list_show(struct seq_file *m, void *v);
1113 static const struct seq_operations nfs_volume_list_ops = {
1114 .start = nfs_volume_list_start,
1115 .next = nfs_volume_list_next,
1116 .stop = nfs_volume_list_stop,
1117 .show = nfs_volume_list_show,
1121 * set up the iterator to start reading from the server list and return the first item
1123 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1124 __acquires(&nn->nfs_client_lock)
1126 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1128 /* lock the list against modification */
1129 spin_lock(&nn->nfs_client_lock);
1130 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1134 * move to next server
1136 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1138 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1140 return seq_list_next(v, &nn->nfs_client_list, pos);
1144 * clean up after reading from the transports list
1146 static void nfs_server_list_stop(struct seq_file *p, void *v)
1147 __releases(&nn->nfs_client_lock)
1149 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1151 spin_unlock(&nn->nfs_client_lock);
1155 * display a header line followed by a load of call lines
1157 static int nfs_server_list_show(struct seq_file *m, void *v)
1159 struct nfs_client *clp;
1160 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1162 /* display header on line 1 */
1163 if (v == &nn->nfs_client_list) {
1164 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1168 /* display one transport per line on subsequent lines */
1169 clp = list_entry(v, struct nfs_client, cl_share_link);
1171 /* Check if the client is initialized */
1172 if (clp->cl_cons_state != NFS_CS_READY)
1176 seq_printf(m, "v%u %s %s %3d %s\n",
1177 clp->rpc_ops->version,
1178 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1179 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1180 refcount_read(&clp->cl_count),
1188 * set up the iterator to start reading from the volume list and return the first item
1190 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1191 __acquires(&nn->nfs_client_lock)
1193 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1195 /* lock the list against modification */
1196 spin_lock(&nn->nfs_client_lock);
1197 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1201 * move to next volume
1203 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1205 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1207 return seq_list_next(v, &nn->nfs_volume_list, pos);
1211 * clean up after reading from the transports list
1213 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1214 __releases(&nn->nfs_client_lock)
1216 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1218 spin_unlock(&nn->nfs_client_lock);
1222 * display a header line followed by a load of call lines
1224 static int nfs_volume_list_show(struct seq_file *m, void *v)
1226 struct nfs_server *server;
1227 struct nfs_client *clp;
1228 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1229 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1230 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1232 /* display header on line 1 */
1233 if (v == &nn->nfs_volume_list) {
1234 seq_puts(m, "NV SERVER PORT DEV FSID"
1238 /* display one transport per line on subsequent lines */
1239 server = list_entry(v, struct nfs_server, master_link);
1240 clp = server->nfs_client;
1242 snprintf(dev, sizeof(dev), "%u:%u",
1243 MAJOR(server->s_dev), MINOR(server->s_dev));
1245 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1246 (unsigned long long) server->fsid.major,
1247 (unsigned long long) server->fsid.minor);
1250 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1251 clp->rpc_ops->version,
1252 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1253 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1256 nfs_server_fscache_state(server));
1262 int nfs_fs_proc_net_init(struct net *net)
1264 struct nfs_net *nn = net_generic(net, nfs_net_id);
1265 struct proc_dir_entry *p;
1267 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1268 if (!nn->proc_nfsfs)
1271 /* a file of servers with which we're dealing */
1272 p = proc_create_net("servers", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1273 &nfs_server_list_ops, sizeof(struct seq_net_private));
1277 /* a file of volumes that we have mounted */
1278 p = proc_create_net("volumes", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1279 &nfs_volume_list_ops, sizeof(struct seq_net_private));
1285 remove_proc_subtree("nfsfs", net->proc_net);
1290 void nfs_fs_proc_net_exit(struct net *net)
1292 remove_proc_subtree("nfsfs", net->proc_net);
1296 * initialise the /proc/fs/nfsfs/ directory
1298 int __init nfs_fs_proc_init(void)
1300 if (!proc_mkdir("fs/nfsfs", NULL))
1303 /* a file of servers with which we're dealing */
1304 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1307 /* a file of volumes that we have mounted */
1308 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1313 remove_proc_subtree("fs/nfsfs", NULL);
1319 * clean up the /proc/fs/nfsfs/ directory
1321 void nfs_fs_proc_exit(void)
1323 remove_proc_subtree("fs/nfsfs", NULL);
1326 #endif /* CONFIG_PROC_FS */