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/addr.h>
24 #include <linux/sunrpc/clnt.h>
25 #include <linux/sunrpc/stats.h>
26 #include <linux/sunrpc/metrics.h>
27 #include <linux/sunrpc/xprtsock.h>
28 #include <linux/sunrpc/xprtrdma.h>
29 #include <linux/nfs_fs.h>
30 #include <linux/nfs_mount.h>
31 #include <linux/nfs4_mount.h>
32 #include <linux/lockd/bind.h>
33 #include <linux/seq_file.h>
34 #include <linux/mount.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);
113 if (!IS_ERR(nfs) && !try_module_get(nfs->owner))
114 return ERR_PTR(-EAGAIN);
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 if (!try_module_get(clp->cl_nfs_mod->owner))
164 clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
166 atomic_set(&clp->cl_count, 1);
167 clp->cl_cons_state = NFS_CS_INITING;
169 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
170 clp->cl_addrlen = cl_init->addrlen;
172 if (cl_init->hostname) {
174 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
175 if (!clp->cl_hostname)
179 INIT_LIST_HEAD(&clp->cl_superblocks);
180 clp->cl_rpcclient = ERR_PTR(-EINVAL);
182 clp->cl_flags = cl_init->init_flags;
183 clp->cl_proto = cl_init->proto;
184 clp->cl_net = get_net(cl_init->net);
186 cred = rpc_lookup_machine_cred("*");
188 clp->cl_machine_cred = cred;
189 nfs_fscache_get_client_cookie(clp);
194 put_nfs_version(clp->cl_nfs_mod);
200 EXPORT_SYMBOL_GPL(nfs_alloc_client);
202 #if IS_ENABLED(CONFIG_NFS_V4)
203 void nfs_cleanup_cb_ident_idr(struct net *net)
205 struct nfs_net *nn = net_generic(net, nfs_net_id);
207 idr_destroy(&nn->cb_ident_idr);
210 /* nfs_client_lock held */
211 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
213 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
215 if (clp->cl_cb_ident)
216 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
219 static void pnfs_init_server(struct nfs_server *server)
221 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
225 void nfs_cleanup_cb_ident_idr(struct net *net)
229 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
233 static void pnfs_init_server(struct nfs_server *server)
237 #endif /* CONFIG_NFS_V4 */
240 * Destroy a shared client record
242 void nfs_free_client(struct nfs_client *clp)
244 nfs_fscache_release_client_cookie(clp);
246 /* -EIO all pending I/O */
247 if (!IS_ERR(clp->cl_rpcclient))
248 rpc_shutdown_client(clp->cl_rpcclient);
250 if (clp->cl_machine_cred != NULL)
251 put_rpccred(clp->cl_machine_cred);
253 put_net(clp->cl_net);
254 put_nfs_version(clp->cl_nfs_mod);
255 kfree(clp->cl_hostname);
256 kfree(clp->cl_acceptor);
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 nn = net_generic(clp->cl_net, nfs_net_id);
273 if (atomic_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
274 list_del(&clp->cl_share_link);
275 nfs_cb_idr_remove_locked(clp);
276 spin_unlock(&nn->nfs_client_lock);
278 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
280 clp->rpc_ops->free_client(clp);
283 EXPORT_SYMBOL_GPL(nfs_put_client);
286 * Find an nfs_client on the list that matches the initialisation data
289 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
291 struct nfs_client *clp;
292 const struct sockaddr *sap = data->addr;
293 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
297 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
298 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
299 /* Don't match clients that failed to initialise properly */
300 if (clp->cl_cons_state < 0)
303 /* If a client is still initializing then we need to wait */
304 if (clp->cl_cons_state > NFS_CS_READY) {
305 atomic_inc(&clp->cl_count);
306 spin_unlock(&nn->nfs_client_lock);
307 error = nfs_wait_client_init_complete(clp);
309 spin_lock(&nn->nfs_client_lock);
311 return ERR_PTR(error);
315 /* Different NFS versions cannot share the same nfs_client */
316 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
319 if (clp->cl_proto != data->proto)
321 /* Match nfsv4 minorversion */
322 if (clp->cl_minorversion != data->minorversion)
324 /* Match the full socket address */
325 if (!rpc_cmp_addr_port(sap, clap))
326 /* Match all xprt_switch full socket addresses */
327 if (IS_ERR(clp->cl_rpcclient) ||
328 !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
332 atomic_inc(&clp->cl_count);
339 * Return true if @clp is done initializing, false if still working on it.
341 * Use nfs_client_init_status to check if it was successful.
343 bool nfs_client_init_is_complete(const struct nfs_client *clp)
345 return clp->cl_cons_state <= NFS_CS_READY;
347 EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
350 * Return 0 if @clp was successfully initialized, -errno otherwise.
352 * This must be called *after* nfs_client_init_is_complete() returns true,
353 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
355 int nfs_client_init_status(const struct nfs_client *clp)
357 /* called without checking nfs_client_init_is_complete */
358 if (clp->cl_cons_state > NFS_CS_READY) {
362 return clp->cl_cons_state;
364 EXPORT_SYMBOL_GPL(nfs_client_init_status);
366 int nfs_wait_client_init_complete(const struct nfs_client *clp)
368 return wait_event_killable(nfs_client_active_wq,
369 nfs_client_init_is_complete(clp));
371 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
374 * Found an existing client. Make sure it's ready before returning.
376 static struct nfs_client *
377 nfs_found_client(const struct nfs_client_initdata *cl_init,
378 struct nfs_client *clp)
382 error = nfs_wait_client_init_complete(clp);
385 return ERR_PTR(-ERESTARTSYS);
388 if (clp->cl_cons_state < NFS_CS_READY) {
389 error = clp->cl_cons_state;
391 return ERR_PTR(error);
399 * Look up a client by IP address and protocol version
400 * - creates a new record if one doesn't yet exist
402 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
404 struct nfs_client *clp, *new = NULL;
405 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
406 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
408 if (cl_init->hostname == NULL) {
410 return ERR_PTR(-EINVAL);
413 /* see if the client already exists */
415 spin_lock(&nn->nfs_client_lock);
417 clp = nfs_match_client(cl_init);
419 spin_unlock(&nn->nfs_client_lock);
421 new->rpc_ops->free_client(new);
424 return nfs_found_client(cl_init, clp);
427 list_add_tail(&new->cl_share_link,
428 &nn->nfs_client_list);
429 spin_unlock(&nn->nfs_client_lock);
430 return rpc_ops->init_client(new, cl_init);
433 spin_unlock(&nn->nfs_client_lock);
435 new = rpc_ops->alloc_client(cl_init);
436 } while (!IS_ERR(new));
440 EXPORT_SYMBOL_GPL(nfs_get_client);
443 * Mark a server as ready or failed
445 void nfs_mark_client_ready(struct nfs_client *clp, int state)
448 clp->cl_cons_state = state;
449 wake_up_all(&nfs_client_active_wq);
451 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
454 * Initialise the timeout values for a connection
456 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
457 int timeo, int retrans)
459 to->to_initval = timeo * HZ / 10;
460 to->to_retries = retrans;
463 case XPRT_TRANSPORT_TCP:
464 case XPRT_TRANSPORT_RDMA:
465 if (retrans == NFS_UNSPEC_RETRANS)
466 to->to_retries = NFS_DEF_TCP_RETRANS;
467 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
468 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
469 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
470 to->to_initval = NFS_MAX_TCP_TIMEOUT;
471 to->to_increment = to->to_initval;
472 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
473 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
474 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
475 if (to->to_maxval < to->to_initval)
476 to->to_maxval = to->to_initval;
477 to->to_exponential = 0;
479 case XPRT_TRANSPORT_UDP:
480 if (retrans == NFS_UNSPEC_RETRANS)
481 to->to_retries = NFS_DEF_UDP_RETRANS;
482 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
483 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
484 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
485 to->to_initval = NFS_MAX_UDP_TIMEOUT;
486 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
487 to->to_exponential = 1;
493 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
496 * Create an RPC client handle
498 int nfs_create_rpc_client(struct nfs_client *clp,
499 const struct nfs_client_initdata *cl_init,
500 rpc_authflavor_t flavor)
502 struct rpc_clnt *clnt = NULL;
503 struct rpc_create_args args = {
505 .protocol = clp->cl_proto,
506 .address = (struct sockaddr *)&clp->cl_addr,
507 .addrsize = clp->cl_addrlen,
508 .timeout = cl_init->timeparms,
509 .servername = clp->cl_hostname,
510 .nodename = cl_init->nodename,
511 .program = &nfs_program,
512 .version = clp->rpc_ops->version,
513 .authflavor = flavor,
516 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
517 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
518 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
519 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
520 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
521 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
522 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
523 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
525 if (!IS_ERR(clp->cl_rpcclient))
528 clnt = rpc_create(&args);
530 dprintk("%s: cannot create RPC client. Error = %ld\n",
531 __func__, PTR_ERR(clnt));
532 return PTR_ERR(clnt);
535 clp->cl_rpcclient = clnt;
538 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
541 * Version 2 or 3 client destruction
543 static void nfs_destroy_server(struct nfs_server *server)
545 if (server->nlm_host)
546 nlmclnt_done(server->nlm_host);
550 * Version 2 or 3 lockd setup
552 static int nfs_start_lockd(struct nfs_server *server)
554 struct nlm_host *host;
555 struct nfs_client *clp = server->nfs_client;
556 struct nlmclnt_initdata nlm_init = {
557 .hostname = clp->cl_hostname,
558 .address = (struct sockaddr *)&clp->cl_addr,
559 .addrlen = clp->cl_addrlen,
560 .nfs_version = clp->rpc_ops->version,
561 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
564 .nlmclnt_ops = clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
567 if (nlm_init.nfs_version > 3)
569 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
570 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
573 switch (clp->cl_proto) {
575 nlm_init.protocol = IPPROTO_TCP;
577 case XPRT_TRANSPORT_UDP:
578 nlm_init.protocol = IPPROTO_UDP;
581 host = nlmclnt_init(&nlm_init);
583 return PTR_ERR(host);
585 server->nlm_host = host;
586 server->destroy = nfs_destroy_server;
591 * Create a general RPC client
593 int nfs_init_server_rpcclient(struct nfs_server *server,
594 const struct rpc_timeout *timeo,
595 rpc_authflavor_t pseudoflavour)
597 struct nfs_client *clp = server->nfs_client;
599 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
601 if (IS_ERR(server->client)) {
602 dprintk("%s: couldn't create rpc_client!\n", __func__);
603 return PTR_ERR(server->client);
606 memcpy(&server->client->cl_timeout_default,
608 sizeof(server->client->cl_timeout_default));
609 server->client->cl_timeout = &server->client->cl_timeout_default;
610 server->client->cl_softrtry = 0;
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,
666 struct nfs_client *clp;
669 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
670 data->timeo, data->retrans);
671 if (data->flags & NFS_MOUNT_NORESVPORT)
672 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
674 /* Allocate or find a client reference we can use */
675 clp = nfs_get_client(&cl_init);
679 server->nfs_client = clp;
681 /* Initialise the client representation from the mount data */
682 server->flags = data->flags;
683 server->options = data->options;
684 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
685 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
686 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
689 server->rsize = nfs_block_size(data->rsize, NULL);
691 server->wsize = nfs_block_size(data->wsize, NULL);
693 server->acregmin = data->acregmin * HZ;
694 server->acregmax = data->acregmax * HZ;
695 server->acdirmin = data->acdirmin * HZ;
696 server->acdirmax = data->acdirmax * HZ;
698 /* Start lockd here, before we might error out */
699 error = nfs_start_lockd(server);
703 server->port = data->nfs_server.port;
704 server->auth_info = data->auth_info;
706 error = nfs_init_server_rpcclient(server, &timeparms,
707 data->selected_flavor);
711 /* Preserve the values of mount_server-related mount options */
712 if (data->mount_server.addrlen) {
713 memcpy(&server->mountd_address, &data->mount_server.address,
714 data->mount_server.addrlen);
715 server->mountd_addrlen = data->mount_server.addrlen;
717 server->mountd_version = data->mount_server.version;
718 server->mountd_port = data->mount_server.port;
719 server->mountd_protocol = data->mount_server.protocol;
721 server->namelen = data->namlen;
725 server->nfs_client = NULL;
731 * Load up the server record from information gained in an fsinfo record
733 static void nfs_server_set_fsinfo(struct nfs_server *server,
734 struct nfs_fsinfo *fsinfo)
736 unsigned long max_rpc_payload;
738 /* Work out a lot of parameters */
739 if (server->rsize == 0)
740 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
741 if (server->wsize == 0)
742 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
744 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
745 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
746 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
747 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
749 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
750 if (server->rsize > max_rpc_payload)
751 server->rsize = max_rpc_payload;
752 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
753 server->rsize = NFS_MAX_FILE_IO_SIZE;
754 server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
756 if (server->wsize > max_rpc_payload)
757 server->wsize = max_rpc_payload;
758 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
759 server->wsize = NFS_MAX_FILE_IO_SIZE;
760 server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
762 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
764 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
765 if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
766 server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
767 if (server->dtsize > server->rsize)
768 server->dtsize = server->rsize;
770 if (server->flags & NFS_MOUNT_NOAC) {
771 server->acregmin = server->acregmax = 0;
772 server->acdirmin = server->acdirmax = 0;
775 server->maxfilesize = fsinfo->maxfilesize;
777 server->time_delta = fsinfo->time_delta;
779 server->clone_blksize = fsinfo->clone_blksize;
780 /* We're airborne Set socket buffersize */
781 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
785 * Probe filesystem information, including the FSID on v2/v3
787 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
789 struct nfs_fsinfo fsinfo;
790 struct nfs_client *clp = server->nfs_client;
793 if (clp->rpc_ops->set_capabilities != NULL) {
794 error = clp->rpc_ops->set_capabilities(server, mntfh);
799 fsinfo.fattr = fattr;
800 fsinfo.nlayouttypes = 0;
801 memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
802 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
806 nfs_server_set_fsinfo(server, &fsinfo);
808 /* Get some general file system info */
809 if (server->namelen == 0) {
810 struct nfs_pathconf pathinfo;
812 pathinfo.fattr = fattr;
813 nfs_fattr_init(fattr);
815 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
816 server->namelen = pathinfo.max_namelen;
821 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
824 * Copy useful information when duplicating a server record
826 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
828 target->flags = source->flags;
829 target->rsize = source->rsize;
830 target->wsize = source->wsize;
831 target->acregmin = source->acregmin;
832 target->acregmax = source->acregmax;
833 target->acdirmin = source->acdirmin;
834 target->acdirmax = source->acdirmax;
835 target->caps = source->caps;
836 target->options = source->options;
837 target->auth_info = source->auth_info;
838 target->port = source->port;
840 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
842 void nfs_server_insert_lists(struct nfs_server *server)
844 struct nfs_client *clp = server->nfs_client;
845 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
847 spin_lock(&nn->nfs_client_lock);
848 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
849 list_add_tail(&server->master_link, &nn->nfs_volume_list);
850 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
851 spin_unlock(&nn->nfs_client_lock);
854 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
856 void nfs_server_remove_lists(struct nfs_server *server)
858 struct nfs_client *clp = server->nfs_client;
863 nn = net_generic(clp->cl_net, nfs_net_id);
864 spin_lock(&nn->nfs_client_lock);
865 list_del_rcu(&server->client_link);
866 if (list_empty(&clp->cl_superblocks))
867 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
868 list_del(&server->master_link);
869 spin_unlock(&nn->nfs_client_lock);
873 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
876 * Allocate and initialise a server record
878 struct nfs_server *nfs_alloc_server(void)
880 struct nfs_server *server;
882 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
886 server->client = server->client_acl = ERR_PTR(-EINVAL);
888 /* Zero out the NFS state stuff */
889 INIT_LIST_HEAD(&server->client_link);
890 INIT_LIST_HEAD(&server->master_link);
891 INIT_LIST_HEAD(&server->delegations);
892 INIT_LIST_HEAD(&server->layouts);
893 INIT_LIST_HEAD(&server->state_owners_lru);
895 atomic_set(&server->active, 0);
897 server->io_stats = nfs_alloc_iostats();
898 if (!server->io_stats) {
903 ida_init(&server->openowner_id);
904 ida_init(&server->lockowner_id);
905 pnfs_init_server(server);
906 rpc_init_wait_queue(&server->uoc_rpcwaitq, "NFS UOC");
910 EXPORT_SYMBOL_GPL(nfs_alloc_server);
913 * Free up a server record
915 void nfs_free_server(struct nfs_server *server)
917 nfs_server_remove_lists(server);
919 if (server->destroy != NULL)
920 server->destroy(server);
922 if (!IS_ERR(server->client_acl))
923 rpc_shutdown_client(server->client_acl);
924 if (!IS_ERR(server->client))
925 rpc_shutdown_client(server->client);
927 nfs_put_client(server->nfs_client);
929 ida_destroy(&server->lockowner_id);
930 ida_destroy(&server->openowner_id);
931 nfs_free_iostats(server->io_stats);
933 nfs_release_automount_timer();
935 EXPORT_SYMBOL_GPL(nfs_free_server);
938 * Create a version 2 or 3 volume record
939 * - keyed on server and FSID
941 struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
942 struct nfs_subversion *nfs_mod)
944 struct nfs_server *server;
945 struct nfs_fattr *fattr;
948 server = nfs_alloc_server();
950 return ERR_PTR(-ENOMEM);
953 fattr = nfs_alloc_fattr();
957 /* Get a client representation */
958 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
962 /* Probe the root fh to retrieve its FSID */
963 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
966 if (server->nfs_client->rpc_ops->version == 3) {
967 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
968 server->namelen = NFS3_MAXNAMLEN;
969 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
970 server->caps |= NFS_CAP_READDIRPLUS;
972 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
973 server->namelen = NFS2_MAXNAMLEN;
976 if (!(fattr->valid & NFS_ATTR_FATTR)) {
977 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr, NULL);
979 dprintk("nfs_create_server: getattr error = %d\n", -error);
983 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
985 dprintk("Server FSID: %llx:%llx\n",
986 (unsigned long long) server->fsid.major,
987 (unsigned long long) server->fsid.minor);
989 nfs_server_insert_lists(server);
990 server->mount_time = jiffies;
991 nfs_free_fattr(fattr);
995 nfs_free_fattr(fattr);
996 nfs_free_server(server);
997 return ERR_PTR(error);
999 EXPORT_SYMBOL_GPL(nfs_create_server);
1002 * Clone an NFS2, NFS3 or NFS4 server record
1004 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1006 struct nfs_fattr *fattr,
1007 rpc_authflavor_t flavor)
1009 struct nfs_server *server;
1010 struct nfs_fattr *fattr_fsinfo;
1013 server = nfs_alloc_server();
1015 return ERR_PTR(-ENOMEM);
1018 fattr_fsinfo = nfs_alloc_fattr();
1019 if (fattr_fsinfo == NULL)
1020 goto out_free_server;
1022 /* Copy data from the source */
1023 server->nfs_client = source->nfs_client;
1024 server->destroy = source->destroy;
1025 atomic_inc(&server->nfs_client->cl_count);
1026 nfs_server_copy_userdata(server, source);
1028 server->fsid = fattr->fsid;
1030 error = nfs_init_server_rpcclient(server,
1031 source->client->cl_timeout,
1034 goto out_free_server;
1036 /* probe the filesystem info for this server filesystem */
1037 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1039 goto out_free_server;
1041 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1042 server->namelen = NFS4_MAXNAMLEN;
1044 error = nfs_start_lockd(server);
1046 goto out_free_server;
1048 nfs_server_insert_lists(server);
1049 server->mount_time = jiffies;
1051 nfs_free_fattr(fattr_fsinfo);
1055 nfs_free_fattr(fattr_fsinfo);
1056 nfs_free_server(server);
1057 return ERR_PTR(error);
1059 EXPORT_SYMBOL_GPL(nfs_clone_server);
1061 void nfs_clients_init(struct net *net)
1063 struct nfs_net *nn = net_generic(net, nfs_net_id);
1065 INIT_LIST_HEAD(&nn->nfs_client_list);
1066 INIT_LIST_HEAD(&nn->nfs_volume_list);
1067 #if IS_ENABLED(CONFIG_NFS_V4)
1068 idr_init(&nn->cb_ident_idr);
1070 spin_lock_init(&nn->nfs_client_lock);
1071 nn->boot_time = ktime_get_real();
1074 #ifdef CONFIG_PROC_FS
1075 static int nfs_server_list_open(struct inode *inode, struct file *file);
1076 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1077 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1078 static void nfs_server_list_stop(struct seq_file *p, void *v);
1079 static int nfs_server_list_show(struct seq_file *m, void *v);
1081 static const struct seq_operations nfs_server_list_ops = {
1082 .start = nfs_server_list_start,
1083 .next = nfs_server_list_next,
1084 .stop = nfs_server_list_stop,
1085 .show = nfs_server_list_show,
1088 static const struct file_operations nfs_server_list_fops = {
1089 .open = nfs_server_list_open,
1091 .llseek = seq_lseek,
1092 .release = seq_release_net,
1095 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1096 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1097 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1098 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1099 static int nfs_volume_list_show(struct seq_file *m, void *v);
1101 static const struct seq_operations nfs_volume_list_ops = {
1102 .start = nfs_volume_list_start,
1103 .next = nfs_volume_list_next,
1104 .stop = nfs_volume_list_stop,
1105 .show = nfs_volume_list_show,
1108 static const struct file_operations nfs_volume_list_fops = {
1109 .open = nfs_volume_list_open,
1111 .llseek = seq_lseek,
1112 .release = seq_release_net,
1116 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1119 static int nfs_server_list_open(struct inode *inode, struct file *file)
1121 return seq_open_net(inode, file, &nfs_server_list_ops,
1122 sizeof(struct seq_net_private));
1126 * set up the iterator to start reading from the server list and return the first item
1128 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1129 __acquires(&nn->nfs_client_lock)
1131 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1133 /* lock the list against modification */
1134 spin_lock(&nn->nfs_client_lock);
1135 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1139 * move to next server
1141 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1143 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1145 return seq_list_next(v, &nn->nfs_client_list, pos);
1149 * clean up after reading from the transports list
1151 static void nfs_server_list_stop(struct seq_file *p, void *v)
1152 __releases(&nn->nfs_client_lock)
1154 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1156 spin_unlock(&nn->nfs_client_lock);
1160 * display a header line followed by a load of call lines
1162 static int nfs_server_list_show(struct seq_file *m, void *v)
1164 struct nfs_client *clp;
1165 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1167 /* display header on line 1 */
1168 if (v == &nn->nfs_client_list) {
1169 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1173 /* display one transport per line on subsequent lines */
1174 clp = list_entry(v, struct nfs_client, cl_share_link);
1176 /* Check if the client is initialized */
1177 if (clp->cl_cons_state != NFS_CS_READY)
1181 seq_printf(m, "v%u %s %s %3d %s\n",
1182 clp->rpc_ops->version,
1183 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1184 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1185 atomic_read(&clp->cl_count),
1193 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1195 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1197 return seq_open_net(inode, file, &nfs_volume_list_ops,
1198 sizeof(struct seq_net_private));
1202 * set up the iterator to start reading from the volume list and return the first item
1204 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1205 __acquires(&nn->nfs_client_lock)
1207 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1209 /* lock the list against modification */
1210 spin_lock(&nn->nfs_client_lock);
1211 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1215 * move to next volume
1217 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1219 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1221 return seq_list_next(v, &nn->nfs_volume_list, pos);
1225 * clean up after reading from the transports list
1227 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1228 __releases(&nn->nfs_client_lock)
1230 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1232 spin_unlock(&nn->nfs_client_lock);
1236 * display a header line followed by a load of call lines
1238 static int nfs_volume_list_show(struct seq_file *m, void *v)
1240 struct nfs_server *server;
1241 struct nfs_client *clp;
1242 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1243 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1244 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1246 /* display header on line 1 */
1247 if (v == &nn->nfs_volume_list) {
1248 seq_puts(m, "NV SERVER PORT DEV FSID"
1252 /* display one transport per line on subsequent lines */
1253 server = list_entry(v, struct nfs_server, master_link);
1254 clp = server->nfs_client;
1256 snprintf(dev, sizeof(dev), "%u:%u",
1257 MAJOR(server->s_dev), MINOR(server->s_dev));
1259 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1260 (unsigned long long) server->fsid.major,
1261 (unsigned long long) server->fsid.minor);
1264 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1265 clp->rpc_ops->version,
1266 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1267 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1270 nfs_server_fscache_state(server));
1276 int nfs_fs_proc_net_init(struct net *net)
1278 struct nfs_net *nn = net_generic(net, nfs_net_id);
1279 struct proc_dir_entry *p;
1281 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1282 if (!nn->proc_nfsfs)
1285 /* a file of servers with which we're dealing */
1286 p = proc_create("servers", S_IFREG|S_IRUGO,
1287 nn->proc_nfsfs, &nfs_server_list_fops);
1291 /* a file of volumes that we have mounted */
1292 p = proc_create("volumes", S_IFREG|S_IRUGO,
1293 nn->proc_nfsfs, &nfs_volume_list_fops);
1299 remove_proc_subtree("nfsfs", net->proc_net);
1304 void nfs_fs_proc_net_exit(struct net *net)
1306 remove_proc_subtree("nfsfs", net->proc_net);
1310 * initialise the /proc/fs/nfsfs/ directory
1312 int __init nfs_fs_proc_init(void)
1314 if (!proc_mkdir("fs/nfsfs", NULL))
1317 /* a file of servers with which we're dealing */
1318 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1321 /* a file of volumes that we have mounted */
1322 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1327 remove_proc_subtree("fs/nfsfs", NULL);
1333 * clean up the /proc/fs/nfsfs/ directory
1335 void nfs_fs_proc_exit(void)
1337 remove_proc_subtree("fs/nfsfs", NULL);
1340 #endif /* CONFIG_PROC_FS */