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 (IS_ERR(clp->cl_rpcclient) ||
318 !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
322 atomic_inc(&clp->cl_count);
329 * Return true if @clp is done initializing, false if still working on it.
331 * Use nfs_client_init_status to check if it was successful.
333 bool nfs_client_init_is_complete(const struct nfs_client *clp)
335 return clp->cl_cons_state <= NFS_CS_READY;
337 EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
340 * Return 0 if @clp was successfully initialized, -errno otherwise.
342 * This must be called *after* nfs_client_init_is_complete() returns true,
343 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
345 int nfs_client_init_status(const struct nfs_client *clp)
347 /* called without checking nfs_client_init_is_complete */
348 if (clp->cl_cons_state > NFS_CS_READY) {
352 return clp->cl_cons_state;
354 EXPORT_SYMBOL_GPL(nfs_client_init_status);
356 int nfs_wait_client_init_complete(const struct nfs_client *clp)
358 return wait_event_killable(nfs_client_active_wq,
359 nfs_client_init_is_complete(clp));
361 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
364 * Found an existing client. Make sure it's ready before returning.
366 static struct nfs_client *
367 nfs_found_client(const struct nfs_client_initdata *cl_init,
368 struct nfs_client *clp)
372 error = nfs_wait_client_init_complete(clp);
375 return ERR_PTR(-ERESTARTSYS);
378 if (clp->cl_cons_state < NFS_CS_READY) {
379 error = clp->cl_cons_state;
381 return ERR_PTR(error);
386 dprintk("<-- %s found nfs_client %p for %s\n",
387 __func__, clp, cl_init->hostname ?: "");
392 * Look up a client by IP address and protocol version
393 * - creates a new record if one doesn't yet exist
395 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
397 struct nfs_client *clp, *new = NULL;
398 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
399 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
401 if (cl_init->hostname == NULL) {
406 dprintk("--> nfs_get_client(%s,v%u)\n",
407 cl_init->hostname, rpc_ops->version);
409 /* see if the client already exists */
411 spin_lock(&nn->nfs_client_lock);
413 clp = nfs_match_client(cl_init);
415 spin_unlock(&nn->nfs_client_lock);
417 new->rpc_ops->free_client(new);
418 return nfs_found_client(cl_init, clp);
421 list_add_tail(&new->cl_share_link,
422 &nn->nfs_client_list);
423 spin_unlock(&nn->nfs_client_lock);
424 new->cl_flags = cl_init->init_flags;
425 return rpc_ops->init_client(new, cl_init);
428 spin_unlock(&nn->nfs_client_lock);
430 new = rpc_ops->alloc_client(cl_init);
431 } while (!IS_ERR(new));
433 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
434 cl_init->hostname, PTR_ERR(new));
437 EXPORT_SYMBOL_GPL(nfs_get_client);
440 * Mark a server as ready or failed
442 void nfs_mark_client_ready(struct nfs_client *clp, int state)
445 clp->cl_cons_state = state;
446 wake_up_all(&nfs_client_active_wq);
448 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
451 * Initialise the timeout values for a connection
453 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
454 int timeo, int retrans)
456 to->to_initval = timeo * HZ / 10;
457 to->to_retries = retrans;
460 case XPRT_TRANSPORT_TCP:
461 case XPRT_TRANSPORT_RDMA:
462 if (retrans == NFS_UNSPEC_RETRANS)
463 to->to_retries = NFS_DEF_TCP_RETRANS;
464 if (timeo == NFS_UNSPEC_TIMEO || to->to_retries == 0)
465 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
466 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
467 to->to_initval = NFS_MAX_TCP_TIMEOUT;
468 to->to_increment = to->to_initval;
469 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
470 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
471 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
472 if (to->to_maxval < to->to_initval)
473 to->to_maxval = to->to_initval;
474 to->to_exponential = 0;
476 case XPRT_TRANSPORT_UDP:
477 if (retrans == NFS_UNSPEC_RETRANS)
478 to->to_retries = NFS_DEF_UDP_RETRANS;
479 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
480 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
481 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
482 to->to_initval = NFS_MAX_UDP_TIMEOUT;
483 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
484 to->to_exponential = 1;
490 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
493 * Create an RPC client handle
495 int nfs_create_rpc_client(struct nfs_client *clp,
496 const struct nfs_client_initdata *cl_init,
497 rpc_authflavor_t flavor)
499 struct rpc_clnt *clnt = NULL;
500 struct rpc_create_args args = {
502 .protocol = clp->cl_proto,
503 .address = (struct sockaddr *)&clp->cl_addr,
504 .addrsize = clp->cl_addrlen,
505 .timeout = cl_init->timeparms,
506 .servername = clp->cl_hostname,
507 .nodename = cl_init->nodename,
508 .program = &nfs_program,
509 .version = clp->rpc_ops->version,
510 .authflavor = flavor,
513 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
514 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
515 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
516 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
517 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
518 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
519 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
520 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
522 if (!IS_ERR(clp->cl_rpcclient))
525 clnt = rpc_create(&args);
527 dprintk("%s: cannot create RPC client. Error = %ld\n",
528 __func__, PTR_ERR(clnt));
529 return PTR_ERR(clnt);
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 ?
563 if (nlm_init.nfs_version > 3)
565 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
566 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
569 switch (clp->cl_proto) {
571 nlm_init.protocol = IPPROTO_TCP;
573 case XPRT_TRANSPORT_UDP:
574 nlm_init.protocol = IPPROTO_UDP;
577 host = nlmclnt_init(&nlm_init);
579 return PTR_ERR(host);
581 server->nlm_host = host;
582 server->destroy = nfs_destroy_server;
587 * Create a general RPC client
589 int nfs_init_server_rpcclient(struct nfs_server *server,
590 const struct rpc_timeout *timeo,
591 rpc_authflavor_t pseudoflavour)
593 struct nfs_client *clp = server->nfs_client;
595 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
597 if (IS_ERR(server->client)) {
598 dprintk("%s: couldn't create rpc_client!\n", __func__);
599 return PTR_ERR(server->client);
602 memcpy(&server->client->cl_timeout_default,
604 sizeof(server->client->cl_timeout_default));
605 server->client->cl_timeout = &server->client->cl_timeout_default;
606 server->client->cl_softrtry = 0;
607 if (server->flags & NFS_MOUNT_SOFT)
608 server->client->cl_softrtry = 1;
612 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
615 * nfs_init_client - Initialise an NFS2 or NFS3 client
617 * @clp: nfs_client to initialise
618 * @cl_init: Initialisation parameters
620 * Returns pointer to an NFS client, or an ERR_PTR value.
622 struct nfs_client *nfs_init_client(struct nfs_client *clp,
623 const struct nfs_client_initdata *cl_init)
627 if (clp->cl_cons_state == NFS_CS_READY) {
628 /* the client is already initialised */
629 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
634 * Create a client RPC handle for doing FSSTAT with UNIX auth only
635 * - RFC 2623, sec 2.3.2
637 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
640 nfs_mark_client_ready(clp, NFS_CS_READY);
644 nfs_mark_client_ready(clp, error);
646 dprintk("<-- nfs_init_client() = xerror %d\n", error);
647 return ERR_PTR(error);
649 EXPORT_SYMBOL_GPL(nfs_init_client);
652 * Create a version 2 or 3 client
654 static int nfs_init_server(struct nfs_server *server,
655 const struct nfs_parsed_mount_data *data,
656 struct nfs_subversion *nfs_mod)
658 struct rpc_timeout timeparms;
659 struct nfs_client_initdata cl_init = {
660 .hostname = data->nfs_server.hostname,
661 .addr = (const struct sockaddr *)&data->nfs_server.address,
662 .addrlen = data->nfs_server.addrlen,
664 .proto = data->nfs_server.protocol,
666 .timeparms = &timeparms,
668 struct nfs_client *clp;
671 dprintk("--> nfs_init_server()\n");
673 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
674 data->timeo, data->retrans);
675 if (data->flags & NFS_MOUNT_NORESVPORT)
676 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
678 /* Allocate or find a client reference we can use */
679 clp = nfs_get_client(&cl_init);
681 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
685 server->nfs_client = clp;
687 /* Initialise the client representation from the mount data */
688 server->flags = data->flags;
689 server->options = data->options;
690 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
691 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
692 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
695 server->rsize = nfs_block_size(data->rsize, NULL);
697 server->wsize = nfs_block_size(data->wsize, NULL);
699 server->acregmin = data->acregmin * HZ;
700 server->acregmax = data->acregmax * HZ;
701 server->acdirmin = data->acdirmin * HZ;
702 server->acdirmax = data->acdirmax * HZ;
704 /* Start lockd here, before we might error out */
705 error = nfs_start_lockd(server);
709 server->port = data->nfs_server.port;
710 server->auth_info = data->auth_info;
712 error = nfs_init_server_rpcclient(server, &timeparms,
713 data->selected_flavor);
717 /* Preserve the values of mount_server-related mount options */
718 if (data->mount_server.addrlen) {
719 memcpy(&server->mountd_address, &data->mount_server.address,
720 data->mount_server.addrlen);
721 server->mountd_addrlen = data->mount_server.addrlen;
723 server->mountd_version = data->mount_server.version;
724 server->mountd_port = data->mount_server.port;
725 server->mountd_protocol = data->mount_server.protocol;
727 server->namelen = data->namlen;
728 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
732 server->nfs_client = NULL;
734 dprintk("<-- nfs_init_server() = xerror %d\n", error);
739 * Load up the server record from information gained in an fsinfo record
741 static void nfs_server_set_fsinfo(struct nfs_server *server,
742 struct nfs_fsinfo *fsinfo)
744 unsigned long max_rpc_payload;
746 /* Work out a lot of parameters */
747 if (server->rsize == 0)
748 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
749 if (server->wsize == 0)
750 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
752 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
753 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
754 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
755 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
757 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
758 if (server->rsize > max_rpc_payload)
759 server->rsize = max_rpc_payload;
760 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
761 server->rsize = NFS_MAX_FILE_IO_SIZE;
762 server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
764 if (server->wsize > max_rpc_payload)
765 server->wsize = max_rpc_payload;
766 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
767 server->wsize = NFS_MAX_FILE_IO_SIZE;
768 server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
770 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
772 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
773 if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
774 server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
775 if (server->dtsize > server->rsize)
776 server->dtsize = server->rsize;
778 if (server->flags & NFS_MOUNT_NOAC) {
779 server->acregmin = server->acregmax = 0;
780 server->acdirmin = server->acdirmax = 0;
783 server->maxfilesize = fsinfo->maxfilesize;
785 server->time_delta = fsinfo->time_delta;
787 server->clone_blksize = fsinfo->clone_blksize;
788 /* We're airborne Set socket buffersize */
789 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
793 * Probe filesystem information, including the FSID on v2/v3
795 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
797 struct nfs_fsinfo fsinfo;
798 struct nfs_client *clp = server->nfs_client;
801 dprintk("--> nfs_probe_fsinfo()\n");
803 if (clp->rpc_ops->set_capabilities != NULL) {
804 error = clp->rpc_ops->set_capabilities(server, mntfh);
809 fsinfo.fattr = fattr;
810 fsinfo.nlayouttypes = 0;
811 memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
812 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
816 nfs_server_set_fsinfo(server, &fsinfo);
818 /* Get some general file system info */
819 if (server->namelen == 0) {
820 struct nfs_pathconf pathinfo;
822 pathinfo.fattr = fattr;
823 nfs_fattr_init(fattr);
825 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
826 server->namelen = pathinfo.max_namelen;
829 dprintk("<-- nfs_probe_fsinfo() = 0\n");
833 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
836 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
839 * Copy useful information when duplicating a server record
841 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
843 target->flags = source->flags;
844 target->rsize = source->rsize;
845 target->wsize = source->wsize;
846 target->acregmin = source->acregmin;
847 target->acregmax = source->acregmax;
848 target->acdirmin = source->acdirmin;
849 target->acdirmax = source->acdirmax;
850 target->caps = source->caps;
851 target->options = source->options;
852 target->auth_info = source->auth_info;
854 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
856 void nfs_server_insert_lists(struct nfs_server *server)
858 struct nfs_client *clp = server->nfs_client;
859 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
861 spin_lock(&nn->nfs_client_lock);
862 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
863 list_add_tail(&server->master_link, &nn->nfs_volume_list);
864 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
865 spin_unlock(&nn->nfs_client_lock);
868 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
870 void nfs_server_remove_lists(struct nfs_server *server)
872 struct nfs_client *clp = server->nfs_client;
877 nn = net_generic(clp->cl_net, nfs_net_id);
878 spin_lock(&nn->nfs_client_lock);
879 list_del_rcu(&server->client_link);
880 if (list_empty(&clp->cl_superblocks))
881 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
882 list_del(&server->master_link);
883 spin_unlock(&nn->nfs_client_lock);
887 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
890 * Allocate and initialise a server record
892 struct nfs_server *nfs_alloc_server(void)
894 struct nfs_server *server;
896 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
900 server->client = server->client_acl = ERR_PTR(-EINVAL);
902 /* Zero out the NFS state stuff */
903 INIT_LIST_HEAD(&server->client_link);
904 INIT_LIST_HEAD(&server->master_link);
905 INIT_LIST_HEAD(&server->delegations);
906 INIT_LIST_HEAD(&server->layouts);
907 INIT_LIST_HEAD(&server->state_owners_lru);
909 atomic_set(&server->active, 0);
911 server->io_stats = nfs_alloc_iostats();
912 if (!server->io_stats) {
917 ida_init(&server->openowner_id);
918 ida_init(&server->lockowner_id);
919 pnfs_init_server(server);
923 EXPORT_SYMBOL_GPL(nfs_alloc_server);
926 * Free up a server record
928 void nfs_free_server(struct nfs_server *server)
930 dprintk("--> nfs_free_server()\n");
932 nfs_server_remove_lists(server);
934 if (server->destroy != NULL)
935 server->destroy(server);
937 if (!IS_ERR(server->client_acl))
938 rpc_shutdown_client(server->client_acl);
939 if (!IS_ERR(server->client))
940 rpc_shutdown_client(server->client);
942 nfs_put_client(server->nfs_client);
944 ida_destroy(&server->lockowner_id);
945 ida_destroy(&server->openowner_id);
946 nfs_free_iostats(server->io_stats);
948 nfs_release_automount_timer();
949 dprintk("<-- nfs_free_server()\n");
951 EXPORT_SYMBOL_GPL(nfs_free_server);
954 * Create a version 2 or 3 volume record
955 * - keyed on server and FSID
957 struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
958 struct nfs_subversion *nfs_mod)
960 struct nfs_server *server;
961 struct nfs_fattr *fattr;
964 server = nfs_alloc_server();
966 return ERR_PTR(-ENOMEM);
969 fattr = nfs_alloc_fattr();
973 /* Get a client representation */
974 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
978 /* Probe the root fh to retrieve its FSID */
979 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
982 if (server->nfs_client->rpc_ops->version == 3) {
983 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
984 server->namelen = NFS3_MAXNAMLEN;
985 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
986 server->caps |= NFS_CAP_READDIRPLUS;
988 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
989 server->namelen = NFS2_MAXNAMLEN;
992 if (!(fattr->valid & NFS_ATTR_FATTR)) {
993 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr, NULL);
995 dprintk("nfs_create_server: getattr error = %d\n", -error);
999 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1001 dprintk("Server FSID: %llx:%llx\n",
1002 (unsigned long long) server->fsid.major,
1003 (unsigned long long) server->fsid.minor);
1005 nfs_server_insert_lists(server);
1006 server->mount_time = jiffies;
1007 nfs_free_fattr(fattr);
1011 nfs_free_fattr(fattr);
1012 nfs_free_server(server);
1013 return ERR_PTR(error);
1015 EXPORT_SYMBOL_GPL(nfs_create_server);
1018 * Clone an NFS2, NFS3 or NFS4 server record
1020 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1022 struct nfs_fattr *fattr,
1023 rpc_authflavor_t flavor)
1025 struct nfs_server *server;
1026 struct nfs_fattr *fattr_fsinfo;
1029 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1030 (unsigned long long) fattr->fsid.major,
1031 (unsigned long long) fattr->fsid.minor);
1033 server = nfs_alloc_server();
1035 return ERR_PTR(-ENOMEM);
1038 fattr_fsinfo = nfs_alloc_fattr();
1039 if (fattr_fsinfo == NULL)
1040 goto out_free_server;
1042 /* Copy data from the source */
1043 server->nfs_client = source->nfs_client;
1044 server->destroy = source->destroy;
1045 atomic_inc(&server->nfs_client->cl_count);
1046 nfs_server_copy_userdata(server, source);
1048 server->fsid = fattr->fsid;
1050 error = nfs_init_server_rpcclient(server,
1051 source->client->cl_timeout,
1054 goto out_free_server;
1056 /* probe the filesystem info for this server filesystem */
1057 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1059 goto out_free_server;
1061 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1062 server->namelen = NFS4_MAXNAMLEN;
1064 dprintk("Cloned FSID: %llx:%llx\n",
1065 (unsigned long long) server->fsid.major,
1066 (unsigned long long) server->fsid.minor);
1068 error = nfs_start_lockd(server);
1070 goto out_free_server;
1072 nfs_server_insert_lists(server);
1073 server->mount_time = jiffies;
1075 nfs_free_fattr(fattr_fsinfo);
1076 dprintk("<-- nfs_clone_server() = %p\n", server);
1080 nfs_free_fattr(fattr_fsinfo);
1081 nfs_free_server(server);
1082 dprintk("<-- nfs_clone_server() = error %d\n", error);
1083 return ERR_PTR(error);
1085 EXPORT_SYMBOL_GPL(nfs_clone_server);
1087 void nfs_clients_init(struct net *net)
1089 struct nfs_net *nn = net_generic(net, nfs_net_id);
1091 INIT_LIST_HEAD(&nn->nfs_client_list);
1092 INIT_LIST_HEAD(&nn->nfs_volume_list);
1093 #if IS_ENABLED(CONFIG_NFS_V4)
1094 idr_init(&nn->cb_ident_idr);
1096 spin_lock_init(&nn->nfs_client_lock);
1097 nn->boot_time = ktime_get_real();
1100 #ifdef CONFIG_PROC_FS
1101 static int nfs_server_list_open(struct inode *inode, struct file *file);
1102 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1103 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1104 static void nfs_server_list_stop(struct seq_file *p, void *v);
1105 static int nfs_server_list_show(struct seq_file *m, void *v);
1107 static const struct seq_operations nfs_server_list_ops = {
1108 .start = nfs_server_list_start,
1109 .next = nfs_server_list_next,
1110 .stop = nfs_server_list_stop,
1111 .show = nfs_server_list_show,
1114 static const struct file_operations nfs_server_list_fops = {
1115 .open = nfs_server_list_open,
1117 .llseek = seq_lseek,
1118 .release = seq_release_net,
1121 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1122 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1123 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1124 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1125 static int nfs_volume_list_show(struct seq_file *m, void *v);
1127 static const struct seq_operations nfs_volume_list_ops = {
1128 .start = nfs_volume_list_start,
1129 .next = nfs_volume_list_next,
1130 .stop = nfs_volume_list_stop,
1131 .show = nfs_volume_list_show,
1134 static const struct file_operations nfs_volume_list_fops = {
1135 .open = nfs_volume_list_open,
1137 .llseek = seq_lseek,
1138 .release = seq_release_net,
1142 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1145 static int nfs_server_list_open(struct inode *inode, struct file *file)
1147 return seq_open_net(inode, file, &nfs_server_list_ops,
1148 sizeof(struct seq_net_private));
1152 * set up the iterator to start reading from the server list and return the first item
1154 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1155 __acquires(&nn->nfs_client_lock)
1157 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1159 /* lock the list against modification */
1160 spin_lock(&nn->nfs_client_lock);
1161 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1165 * move to next server
1167 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1169 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1171 return seq_list_next(v, &nn->nfs_client_list, pos);
1175 * clean up after reading from the transports list
1177 static void nfs_server_list_stop(struct seq_file *p, void *v)
1178 __releases(&nn->nfs_client_lock)
1180 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1182 spin_unlock(&nn->nfs_client_lock);
1186 * display a header line followed by a load of call lines
1188 static int nfs_server_list_show(struct seq_file *m, void *v)
1190 struct nfs_client *clp;
1191 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1193 /* display header on line 1 */
1194 if (v == &nn->nfs_client_list) {
1195 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1199 /* display one transport per line on subsequent lines */
1200 clp = list_entry(v, struct nfs_client, cl_share_link);
1202 /* Check if the client is initialized */
1203 if (clp->cl_cons_state != NFS_CS_READY)
1207 seq_printf(m, "v%u %s %s %3d %s\n",
1208 clp->rpc_ops->version,
1209 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1210 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1211 atomic_read(&clp->cl_count),
1219 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1221 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1223 return seq_open_net(inode, file, &nfs_volume_list_ops,
1224 sizeof(struct seq_net_private));
1228 * set up the iterator to start reading from the volume list and return the first item
1230 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1231 __acquires(&nn->nfs_client_lock)
1233 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1235 /* lock the list against modification */
1236 spin_lock(&nn->nfs_client_lock);
1237 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1241 * move to next volume
1243 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1245 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1247 return seq_list_next(v, &nn->nfs_volume_list, pos);
1251 * clean up after reading from the transports list
1253 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1254 __releases(&nn->nfs_client_lock)
1256 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1258 spin_unlock(&nn->nfs_client_lock);
1262 * display a header line followed by a load of call lines
1264 static int nfs_volume_list_show(struct seq_file *m, void *v)
1266 struct nfs_server *server;
1267 struct nfs_client *clp;
1268 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1269 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1270 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1272 /* display header on line 1 */
1273 if (v == &nn->nfs_volume_list) {
1274 seq_puts(m, "NV SERVER PORT DEV FSID"
1278 /* display one transport per line on subsequent lines */
1279 server = list_entry(v, struct nfs_server, master_link);
1280 clp = server->nfs_client;
1282 snprintf(dev, sizeof(dev), "%u:%u",
1283 MAJOR(server->s_dev), MINOR(server->s_dev));
1285 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1286 (unsigned long long) server->fsid.major,
1287 (unsigned long long) server->fsid.minor);
1290 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1291 clp->rpc_ops->version,
1292 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1293 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1296 nfs_server_fscache_state(server));
1302 int nfs_fs_proc_net_init(struct net *net)
1304 struct nfs_net *nn = net_generic(net, nfs_net_id);
1305 struct proc_dir_entry *p;
1307 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1308 if (!nn->proc_nfsfs)
1311 /* a file of servers with which we're dealing */
1312 p = proc_create("servers", S_IFREG|S_IRUGO,
1313 nn->proc_nfsfs, &nfs_server_list_fops);
1317 /* a file of volumes that we have mounted */
1318 p = proc_create("volumes", S_IFREG|S_IRUGO,
1319 nn->proc_nfsfs, &nfs_volume_list_fops);
1325 remove_proc_subtree("nfsfs", net->proc_net);
1330 void nfs_fs_proc_net_exit(struct net *net)
1332 remove_proc_subtree("nfsfs", net->proc_net);
1336 * initialise the /proc/fs/nfsfs/ directory
1338 int __init nfs_fs_proc_init(void)
1340 if (!proc_mkdir("fs/nfsfs", NULL))
1343 /* a file of servers with which we're dealing */
1344 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1347 /* a file of volumes that we have mounted */
1348 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1353 remove_proc_subtree("fs/nfsfs", NULL);
1359 * clean up the /proc/fs/nfsfs/ directory
1361 void nfs_fs_proc_exit(void)
1363 remove_proc_subtree("fs/nfsfs", NULL);
1366 #endif /* CONFIG_PROC_FS */