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_proto = cl_init->proto;
183 clp->cl_net = get_net(cl_init->net);
185 cred = rpc_lookup_machine_cred("*");
187 clp->cl_machine_cred = cred;
188 nfs_fscache_get_client_cookie(clp);
193 put_nfs_version(clp->cl_nfs_mod);
199 EXPORT_SYMBOL_GPL(nfs_alloc_client);
201 #if IS_ENABLED(CONFIG_NFS_V4)
202 void nfs_cleanup_cb_ident_idr(struct net *net)
204 struct nfs_net *nn = net_generic(net, nfs_net_id);
206 idr_destroy(&nn->cb_ident_idr);
209 /* nfs_client_lock held */
210 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
212 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
214 if (clp->cl_cb_ident)
215 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
218 static void pnfs_init_server(struct nfs_server *server)
220 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
224 void nfs_cleanup_cb_ident_idr(struct net *net)
228 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
232 static void pnfs_init_server(struct nfs_server *server)
236 #endif /* CONFIG_NFS_V4 */
239 * Destroy a shared client record
241 void nfs_free_client(struct nfs_client *clp)
243 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
245 nfs_fscache_release_client_cookie(clp);
247 /* -EIO all pending I/O */
248 if (!IS_ERR(clp->cl_rpcclient))
249 rpc_shutdown_client(clp->cl_rpcclient);
251 if (clp->cl_machine_cred != NULL)
252 put_rpccred(clp->cl_machine_cred);
254 put_net(clp->cl_net);
255 put_nfs_version(clp->cl_nfs_mod);
256 kfree(clp->cl_hostname);
257 kfree(clp->cl_acceptor);
260 dprintk("<-- nfs_free_client()\n");
262 EXPORT_SYMBOL_GPL(nfs_free_client);
265 * Release a reference to a shared client record
267 void nfs_put_client(struct nfs_client *clp)
274 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
275 nn = net_generic(clp->cl_net, nfs_net_id);
277 if (atomic_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
278 list_del(&clp->cl_share_link);
279 nfs_cb_idr_remove_locked(clp);
280 spin_unlock(&nn->nfs_client_lock);
282 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
284 clp->rpc_ops->free_client(clp);
287 EXPORT_SYMBOL_GPL(nfs_put_client);
290 * Find an nfs_client on the list that matches the initialisation data
293 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
295 struct nfs_client *clp;
296 const struct sockaddr *sap = data->addr;
297 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
299 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
300 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
301 /* Don't match clients that failed to initialise properly */
302 if (clp->cl_cons_state < 0)
305 /* Different NFS versions cannot share the same nfs_client */
306 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
309 if (clp->cl_proto != data->proto)
311 /* Match nfsv4 minorversion */
312 if (clp->cl_minorversion != data->minorversion)
314 /* Match the full socket address */
315 if (!rpc_cmp_addr_port(sap, clap))
316 /* Match all xprt_switch full socket addresses */
317 if (!rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
321 atomic_inc(&clp->cl_count);
327 static bool nfs_client_init_is_complete(const struct nfs_client *clp)
329 return clp->cl_cons_state <= NFS_CS_READY;
332 int nfs_wait_client_init_complete(const struct nfs_client *clp)
334 return wait_event_killable(nfs_client_active_wq,
335 nfs_client_init_is_complete(clp));
337 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
340 * Found an existing client. Make sure it's ready before returning.
342 static struct nfs_client *
343 nfs_found_client(const struct nfs_client_initdata *cl_init,
344 struct nfs_client *clp)
348 error = nfs_wait_client_init_complete(clp);
351 return ERR_PTR(-ERESTARTSYS);
354 if (clp->cl_cons_state < NFS_CS_READY) {
355 error = clp->cl_cons_state;
357 return ERR_PTR(error);
362 dprintk("<-- %s found nfs_client %p for %s\n",
363 __func__, clp, cl_init->hostname ?: "");
368 * Look up a client by IP address and protocol version
369 * - creates a new record if one doesn't yet exist
372 nfs_get_client(const struct nfs_client_initdata *cl_init,
373 rpc_authflavor_t authflavour)
375 struct nfs_client *clp, *new = NULL;
376 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
377 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
379 if (cl_init->hostname == NULL) {
384 dprintk("--> nfs_get_client(%s,v%u)\n",
385 cl_init->hostname, rpc_ops->version);
387 /* see if the client already exists */
389 spin_lock(&nn->nfs_client_lock);
391 clp = nfs_match_client(cl_init);
393 spin_unlock(&nn->nfs_client_lock);
395 new->rpc_ops->free_client(new);
396 return nfs_found_client(cl_init, clp);
399 list_add_tail(&new->cl_share_link,
400 &nn->nfs_client_list);
401 spin_unlock(&nn->nfs_client_lock);
402 new->cl_flags = cl_init->init_flags;
403 return rpc_ops->init_client(new, cl_init);
406 spin_unlock(&nn->nfs_client_lock);
408 new = rpc_ops->alloc_client(cl_init);
409 } while (!IS_ERR(new));
411 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
412 cl_init->hostname, PTR_ERR(new));
415 EXPORT_SYMBOL_GPL(nfs_get_client);
418 * Mark a server as ready or failed
420 void nfs_mark_client_ready(struct nfs_client *clp, int state)
423 clp->cl_cons_state = state;
424 wake_up_all(&nfs_client_active_wq);
426 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
429 * Initialise the timeout values for a connection
431 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
432 int timeo, int retrans)
434 to->to_initval = timeo * HZ / 10;
435 to->to_retries = retrans;
438 case XPRT_TRANSPORT_TCP:
439 case XPRT_TRANSPORT_RDMA:
440 if (retrans == NFS_UNSPEC_RETRANS)
441 to->to_retries = NFS_DEF_TCP_RETRANS;
442 if (timeo == NFS_UNSPEC_TIMEO || to->to_retries == 0)
443 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
444 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
445 to->to_initval = NFS_MAX_TCP_TIMEOUT;
446 to->to_increment = to->to_initval;
447 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
448 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
449 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
450 if (to->to_maxval < to->to_initval)
451 to->to_maxval = to->to_initval;
452 to->to_exponential = 0;
454 case XPRT_TRANSPORT_UDP:
455 if (retrans == NFS_UNSPEC_RETRANS)
456 to->to_retries = NFS_DEF_UDP_RETRANS;
457 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
458 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
459 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
460 to->to_initval = NFS_MAX_UDP_TIMEOUT;
461 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
462 to->to_exponential = 1;
468 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
471 * Create an RPC client handle
473 int nfs_create_rpc_client(struct nfs_client *clp,
474 const struct nfs_client_initdata *cl_init,
475 rpc_authflavor_t flavor)
477 struct rpc_clnt *clnt = NULL;
478 struct rpc_create_args args = {
480 .protocol = clp->cl_proto,
481 .address = (struct sockaddr *)&clp->cl_addr,
482 .addrsize = clp->cl_addrlen,
483 .timeout = cl_init->timeparms,
484 .servername = clp->cl_hostname,
485 .nodename = cl_init->nodename,
486 .program = &nfs_program,
487 .version = clp->rpc_ops->version,
488 .authflavor = flavor,
491 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
492 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
493 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
494 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
495 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
496 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
497 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
498 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
500 if (!IS_ERR(clp->cl_rpcclient))
503 clnt = rpc_create(&args);
505 dprintk("%s: cannot create RPC client. Error = %ld\n",
506 __func__, PTR_ERR(clnt));
507 return PTR_ERR(clnt);
510 clp->cl_rpcclient = clnt;
513 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
516 * Version 2 or 3 client destruction
518 static void nfs_destroy_server(struct nfs_server *server)
520 if (server->nlm_host)
521 nlmclnt_done(server->nlm_host);
525 * Version 2 or 3 lockd setup
527 static int nfs_start_lockd(struct nfs_server *server)
529 struct nlm_host *host;
530 struct nfs_client *clp = server->nfs_client;
531 struct nlmclnt_initdata nlm_init = {
532 .hostname = clp->cl_hostname,
533 .address = (struct sockaddr *)&clp->cl_addr,
534 .addrlen = clp->cl_addrlen,
535 .nfs_version = clp->rpc_ops->version,
536 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
541 if (nlm_init.nfs_version > 3)
543 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
544 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
547 switch (clp->cl_proto) {
549 nlm_init.protocol = IPPROTO_TCP;
551 case XPRT_TRANSPORT_UDP:
552 nlm_init.protocol = IPPROTO_UDP;
555 host = nlmclnt_init(&nlm_init);
557 return PTR_ERR(host);
559 server->nlm_host = host;
560 server->destroy = nfs_destroy_server;
565 * Create a general RPC client
567 int nfs_init_server_rpcclient(struct nfs_server *server,
568 const struct rpc_timeout *timeo,
569 rpc_authflavor_t pseudoflavour)
571 struct nfs_client *clp = server->nfs_client;
573 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
575 if (IS_ERR(server->client)) {
576 dprintk("%s: couldn't create rpc_client!\n", __func__);
577 return PTR_ERR(server->client);
580 memcpy(&server->client->cl_timeout_default,
582 sizeof(server->client->cl_timeout_default));
583 server->client->cl_timeout = &server->client->cl_timeout_default;
584 server->client->cl_softrtry = 0;
585 if (server->flags & NFS_MOUNT_SOFT)
586 server->client->cl_softrtry = 1;
590 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
593 * nfs_init_client - Initialise an NFS2 or NFS3 client
595 * @clp: nfs_client to initialise
596 * @cl_init: Initialisation parameters
598 * Returns pointer to an NFS client, or an ERR_PTR value.
600 struct nfs_client *nfs_init_client(struct nfs_client *clp,
601 const struct nfs_client_initdata *cl_init)
605 if (clp->cl_cons_state == NFS_CS_READY) {
606 /* the client is already initialised */
607 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
612 * Create a client RPC handle for doing FSSTAT with UNIX auth only
613 * - RFC 2623, sec 2.3.2
615 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
618 nfs_mark_client_ready(clp, NFS_CS_READY);
622 nfs_mark_client_ready(clp, error);
624 dprintk("<-- nfs_init_client() = xerror %d\n", error);
625 return ERR_PTR(error);
627 EXPORT_SYMBOL_GPL(nfs_init_client);
630 * Create a version 2 or 3 client
632 static int nfs_init_server(struct nfs_server *server,
633 const struct nfs_parsed_mount_data *data,
634 struct nfs_subversion *nfs_mod)
636 struct rpc_timeout timeparms;
637 struct nfs_client_initdata cl_init = {
638 .hostname = data->nfs_server.hostname,
639 .addr = (const struct sockaddr *)&data->nfs_server.address,
640 .addrlen = data->nfs_server.addrlen,
642 .proto = data->nfs_server.protocol,
644 .timeparms = &timeparms,
646 struct nfs_client *clp;
649 dprintk("--> nfs_init_server()\n");
651 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
652 data->timeo, data->retrans);
653 if (data->flags & NFS_MOUNT_NORESVPORT)
654 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
656 /* Allocate or find a client reference we can use */
657 clp = nfs_get_client(&cl_init, RPC_AUTH_UNIX);
659 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
663 server->nfs_client = clp;
665 /* Initialise the client representation from the mount data */
666 server->flags = data->flags;
667 server->options = data->options;
668 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
669 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
670 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
673 server->rsize = nfs_block_size(data->rsize, NULL);
675 server->wsize = nfs_block_size(data->wsize, NULL);
677 server->acregmin = data->acregmin * HZ;
678 server->acregmax = data->acregmax * HZ;
679 server->acdirmin = data->acdirmin * HZ;
680 server->acdirmax = data->acdirmax * HZ;
682 /* Start lockd here, before we might error out */
683 error = nfs_start_lockd(server);
687 server->port = data->nfs_server.port;
688 server->auth_info = data->auth_info;
690 error = nfs_init_server_rpcclient(server, &timeparms,
691 data->selected_flavor);
695 /* Preserve the values of mount_server-related mount options */
696 if (data->mount_server.addrlen) {
697 memcpy(&server->mountd_address, &data->mount_server.address,
698 data->mount_server.addrlen);
699 server->mountd_addrlen = data->mount_server.addrlen;
701 server->mountd_version = data->mount_server.version;
702 server->mountd_port = data->mount_server.port;
703 server->mountd_protocol = data->mount_server.protocol;
705 server->namelen = data->namlen;
706 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
710 server->nfs_client = NULL;
712 dprintk("<-- nfs_init_server() = xerror %d\n", error);
717 * Load up the server record from information gained in an fsinfo record
719 static void nfs_server_set_fsinfo(struct nfs_server *server,
720 struct nfs_fsinfo *fsinfo)
722 unsigned long max_rpc_payload;
724 /* Work out a lot of parameters */
725 if (server->rsize == 0)
726 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
727 if (server->wsize == 0)
728 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
730 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
731 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
732 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
733 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
735 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
736 if (server->rsize > max_rpc_payload)
737 server->rsize = max_rpc_payload;
738 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
739 server->rsize = NFS_MAX_FILE_IO_SIZE;
740 server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
742 server->backing_dev_info.name = "nfs";
743 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
745 if (server->wsize > max_rpc_payload)
746 server->wsize = max_rpc_payload;
747 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
748 server->wsize = NFS_MAX_FILE_IO_SIZE;
749 server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
751 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
753 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
754 if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
755 server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
756 if (server->dtsize > server->rsize)
757 server->dtsize = server->rsize;
759 if (server->flags & NFS_MOUNT_NOAC) {
760 server->acregmin = server->acregmax = 0;
761 server->acdirmin = server->acdirmax = 0;
764 server->maxfilesize = fsinfo->maxfilesize;
766 server->time_delta = fsinfo->time_delta;
768 server->clone_blksize = fsinfo->clone_blksize;
769 /* We're airborne Set socket buffersize */
770 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
774 * Probe filesystem information, including the FSID on v2/v3
776 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
778 struct nfs_fsinfo fsinfo;
779 struct nfs_client *clp = server->nfs_client;
782 dprintk("--> nfs_probe_fsinfo()\n");
784 if (clp->rpc_ops->set_capabilities != NULL) {
785 error = clp->rpc_ops->set_capabilities(server, mntfh);
790 fsinfo.fattr = fattr;
791 fsinfo.nlayouttypes = 0;
792 memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
793 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
797 nfs_server_set_fsinfo(server, &fsinfo);
799 /* Get some general file system info */
800 if (server->namelen == 0) {
801 struct nfs_pathconf pathinfo;
803 pathinfo.fattr = fattr;
804 nfs_fattr_init(fattr);
806 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
807 server->namelen = pathinfo.max_namelen;
810 dprintk("<-- nfs_probe_fsinfo() = 0\n");
814 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
817 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
820 * Copy useful information when duplicating a server record
822 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
824 target->flags = source->flags;
825 target->rsize = source->rsize;
826 target->wsize = source->wsize;
827 target->acregmin = source->acregmin;
828 target->acregmax = source->acregmax;
829 target->acdirmin = source->acdirmin;
830 target->acdirmax = source->acdirmax;
831 target->caps = source->caps;
832 target->options = source->options;
833 target->auth_info = source->auth_info;
835 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
837 void nfs_server_insert_lists(struct nfs_server *server)
839 struct nfs_client *clp = server->nfs_client;
840 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
842 spin_lock(&nn->nfs_client_lock);
843 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
844 list_add_tail(&server->master_link, &nn->nfs_volume_list);
845 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
846 spin_unlock(&nn->nfs_client_lock);
849 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
851 void nfs_server_remove_lists(struct nfs_server *server)
853 struct nfs_client *clp = server->nfs_client;
858 nn = net_generic(clp->cl_net, nfs_net_id);
859 spin_lock(&nn->nfs_client_lock);
860 list_del_rcu(&server->client_link);
861 if (list_empty(&clp->cl_superblocks))
862 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
863 list_del(&server->master_link);
864 spin_unlock(&nn->nfs_client_lock);
868 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
871 * Allocate and initialise a server record
873 struct nfs_server *nfs_alloc_server(void)
875 struct nfs_server *server;
877 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
881 server->client = server->client_acl = ERR_PTR(-EINVAL);
883 /* Zero out the NFS state stuff */
884 INIT_LIST_HEAD(&server->client_link);
885 INIT_LIST_HEAD(&server->master_link);
886 INIT_LIST_HEAD(&server->delegations);
887 INIT_LIST_HEAD(&server->layouts);
888 INIT_LIST_HEAD(&server->state_owners_lru);
890 atomic_set(&server->active, 0);
892 server->io_stats = nfs_alloc_iostats();
893 if (!server->io_stats) {
898 if (bdi_init(&server->backing_dev_info)) {
899 nfs_free_iostats(server->io_stats);
904 ida_init(&server->openowner_id);
905 ida_init(&server->lockowner_id);
906 pnfs_init_server(server);
910 EXPORT_SYMBOL_GPL(nfs_alloc_server);
913 * Free up a server record
915 void nfs_free_server(struct nfs_server *server)
917 dprintk("--> nfs_free_server()\n");
919 nfs_server_remove_lists(server);
921 if (server->destroy != NULL)
922 server->destroy(server);
924 if (!IS_ERR(server->client_acl))
925 rpc_shutdown_client(server->client_acl);
926 if (!IS_ERR(server->client))
927 rpc_shutdown_client(server->client);
929 nfs_put_client(server->nfs_client);
931 ida_destroy(&server->lockowner_id);
932 ida_destroy(&server->openowner_id);
933 nfs_free_iostats(server->io_stats);
934 bdi_destroy(&server->backing_dev_info);
936 nfs_release_automount_timer();
937 dprintk("<-- nfs_free_server()\n");
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);
957 fattr = nfs_alloc_fattr();
961 /* Get a client representation */
962 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
966 /* Probe the root fh to retrieve its FSID */
967 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
970 if (server->nfs_client->rpc_ops->version == 3) {
971 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
972 server->namelen = NFS3_MAXNAMLEN;
973 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
974 server->caps |= NFS_CAP_READDIRPLUS;
976 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
977 server->namelen = NFS2_MAXNAMLEN;
980 if (!(fattr->valid & NFS_ATTR_FATTR)) {
981 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr, NULL);
983 dprintk("nfs_create_server: getattr error = %d\n", -error);
987 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
989 dprintk("Server FSID: %llx:%llx\n",
990 (unsigned long long) server->fsid.major,
991 (unsigned long long) server->fsid.minor);
993 nfs_server_insert_lists(server);
994 server->mount_time = jiffies;
995 nfs_free_fattr(fattr);
999 nfs_free_fattr(fattr);
1000 nfs_free_server(server);
1001 return ERR_PTR(error);
1003 EXPORT_SYMBOL_GPL(nfs_create_server);
1006 * Clone an NFS2, NFS3 or NFS4 server record
1008 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1010 struct nfs_fattr *fattr,
1011 rpc_authflavor_t flavor)
1013 struct nfs_server *server;
1014 struct nfs_fattr *fattr_fsinfo;
1017 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1018 (unsigned long long) fattr->fsid.major,
1019 (unsigned long long) fattr->fsid.minor);
1021 server = nfs_alloc_server();
1023 return ERR_PTR(-ENOMEM);
1026 fattr_fsinfo = nfs_alloc_fattr();
1027 if (fattr_fsinfo == NULL)
1028 goto out_free_server;
1030 /* Copy data from the source */
1031 server->nfs_client = source->nfs_client;
1032 server->destroy = source->destroy;
1033 atomic_inc(&server->nfs_client->cl_count);
1034 nfs_server_copy_userdata(server, source);
1036 server->fsid = fattr->fsid;
1038 error = nfs_init_server_rpcclient(server,
1039 source->client->cl_timeout,
1042 goto out_free_server;
1044 /* probe the filesystem info for this server filesystem */
1045 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1047 goto out_free_server;
1049 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1050 server->namelen = NFS4_MAXNAMLEN;
1052 dprintk("Cloned FSID: %llx:%llx\n",
1053 (unsigned long long) server->fsid.major,
1054 (unsigned long long) server->fsid.minor);
1056 error = nfs_start_lockd(server);
1058 goto out_free_server;
1060 nfs_server_insert_lists(server);
1061 server->mount_time = jiffies;
1063 nfs_free_fattr(fattr_fsinfo);
1064 dprintk("<-- nfs_clone_server() = %p\n", server);
1068 nfs_free_fattr(fattr_fsinfo);
1069 nfs_free_server(server);
1070 dprintk("<-- nfs_clone_server() = error %d\n", error);
1071 return ERR_PTR(error);
1073 EXPORT_SYMBOL_GPL(nfs_clone_server);
1075 void nfs_clients_init(struct net *net)
1077 struct nfs_net *nn = net_generic(net, nfs_net_id);
1079 INIT_LIST_HEAD(&nn->nfs_client_list);
1080 INIT_LIST_HEAD(&nn->nfs_volume_list);
1081 #if IS_ENABLED(CONFIG_NFS_V4)
1082 idr_init(&nn->cb_ident_idr);
1084 spin_lock_init(&nn->nfs_client_lock);
1085 nn->boot_time = ktime_get_real();
1088 #ifdef CONFIG_PROC_FS
1089 static int nfs_server_list_open(struct inode *inode, struct file *file);
1090 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1091 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1092 static void nfs_server_list_stop(struct seq_file *p, void *v);
1093 static int nfs_server_list_show(struct seq_file *m, void *v);
1095 static const struct seq_operations nfs_server_list_ops = {
1096 .start = nfs_server_list_start,
1097 .next = nfs_server_list_next,
1098 .stop = nfs_server_list_stop,
1099 .show = nfs_server_list_show,
1102 static const struct file_operations nfs_server_list_fops = {
1103 .open = nfs_server_list_open,
1105 .llseek = seq_lseek,
1106 .release = seq_release_net,
1109 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1110 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1111 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1112 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1113 static int nfs_volume_list_show(struct seq_file *m, void *v);
1115 static const struct seq_operations nfs_volume_list_ops = {
1116 .start = nfs_volume_list_start,
1117 .next = nfs_volume_list_next,
1118 .stop = nfs_volume_list_stop,
1119 .show = nfs_volume_list_show,
1122 static const struct file_operations nfs_volume_list_fops = {
1123 .open = nfs_volume_list_open,
1125 .llseek = seq_lseek,
1126 .release = seq_release_net,
1130 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1133 static int nfs_server_list_open(struct inode *inode, struct file *file)
1135 return seq_open_net(inode, file, &nfs_server_list_ops,
1136 sizeof(struct seq_net_private));
1140 * set up the iterator to start reading from the server list and return the first item
1142 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1143 __acquires(&nn->nfs_client_lock)
1145 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1147 /* lock the list against modification */
1148 spin_lock(&nn->nfs_client_lock);
1149 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1153 * move to next server
1155 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1157 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1159 return seq_list_next(v, &nn->nfs_client_list, pos);
1163 * clean up after reading from the transports list
1165 static void nfs_server_list_stop(struct seq_file *p, void *v)
1166 __releases(&nn->nfs_client_lock)
1168 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1170 spin_unlock(&nn->nfs_client_lock);
1174 * display a header line followed by a load of call lines
1176 static int nfs_server_list_show(struct seq_file *m, void *v)
1178 struct nfs_client *clp;
1179 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1181 /* display header on line 1 */
1182 if (v == &nn->nfs_client_list) {
1183 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1187 /* display one transport per line on subsequent lines */
1188 clp = list_entry(v, struct nfs_client, cl_share_link);
1190 /* Check if the client is initialized */
1191 if (clp->cl_cons_state != NFS_CS_READY)
1195 seq_printf(m, "v%u %s %s %3d %s\n",
1196 clp->rpc_ops->version,
1197 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1198 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1199 atomic_read(&clp->cl_count),
1207 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1209 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1211 return seq_open_net(inode, file, &nfs_volume_list_ops,
1212 sizeof(struct seq_net_private));
1216 * set up the iterator to start reading from the volume list and return the first item
1218 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1219 __acquires(&nn->nfs_client_lock)
1221 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1223 /* lock the list against modification */
1224 spin_lock(&nn->nfs_client_lock);
1225 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1229 * move to next volume
1231 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1233 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1235 return seq_list_next(v, &nn->nfs_volume_list, pos);
1239 * clean up after reading from the transports list
1241 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1242 __releases(&nn->nfs_client_lock)
1244 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1246 spin_unlock(&nn->nfs_client_lock);
1250 * display a header line followed by a load of call lines
1252 static int nfs_volume_list_show(struct seq_file *m, void *v)
1254 struct nfs_server *server;
1255 struct nfs_client *clp;
1256 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1257 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1258 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1260 /* display header on line 1 */
1261 if (v == &nn->nfs_volume_list) {
1262 seq_puts(m, "NV SERVER PORT DEV FSID"
1266 /* display one transport per line on subsequent lines */
1267 server = list_entry(v, struct nfs_server, master_link);
1268 clp = server->nfs_client;
1270 snprintf(dev, sizeof(dev), "%u:%u",
1271 MAJOR(server->s_dev), MINOR(server->s_dev));
1273 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1274 (unsigned long long) server->fsid.major,
1275 (unsigned long long) server->fsid.minor);
1278 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1279 clp->rpc_ops->version,
1280 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1281 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1284 nfs_server_fscache_state(server));
1290 int nfs_fs_proc_net_init(struct net *net)
1292 struct nfs_net *nn = net_generic(net, nfs_net_id);
1293 struct proc_dir_entry *p;
1295 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1296 if (!nn->proc_nfsfs)
1299 /* a file of servers with which we're dealing */
1300 p = proc_create("servers", S_IFREG|S_IRUGO,
1301 nn->proc_nfsfs, &nfs_server_list_fops);
1305 /* a file of volumes that we have mounted */
1306 p = proc_create("volumes", S_IFREG|S_IRUGO,
1307 nn->proc_nfsfs, &nfs_volume_list_fops);
1313 remove_proc_subtree("nfsfs", net->proc_net);
1318 void nfs_fs_proc_net_exit(struct net *net)
1320 remove_proc_subtree("nfsfs", net->proc_net);
1324 * initialise the /proc/fs/nfsfs/ directory
1326 int __init nfs_fs_proc_init(void)
1328 if (!proc_mkdir("fs/nfsfs", NULL))
1331 /* a file of servers with which we're dealing */
1332 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1335 /* a file of volumes that we have mounted */
1336 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1341 remove_proc_subtree("fs/nfsfs", NULL);
1347 * clean up the /proc/fs/nfsfs/ directory
1349 void nfs_fs_proc_exit(void)
1351 remove_proc_subtree("fs/nfsfs", NULL);
1354 #endif /* CONFIG_PROC_FS */