1 /* client.c: NFS client sharing and management code
3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
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 nfs_fscache_release_client_cookie(clp);
245 /* -EIO all pending I/O */
246 if (!IS_ERR(clp->cl_rpcclient))
247 rpc_shutdown_client(clp->cl_rpcclient);
249 if (clp->cl_machine_cred != NULL)
250 put_rpccred(clp->cl_machine_cred);
252 put_net(clp->cl_net);
253 put_nfs_version(clp->cl_nfs_mod);
254 kfree(clp->cl_hostname);
255 kfree(clp->cl_acceptor);
258 EXPORT_SYMBOL_GPL(nfs_free_client);
261 * Release a reference to a shared client record
263 void nfs_put_client(struct nfs_client *clp)
270 nn = net_generic(clp->cl_net, nfs_net_id);
272 if (atomic_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
273 list_del(&clp->cl_share_link);
274 nfs_cb_idr_remove_locked(clp);
275 spin_unlock(&nn->nfs_client_lock);
277 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
279 clp->rpc_ops->free_client(clp);
282 EXPORT_SYMBOL_GPL(nfs_put_client);
285 * Find an nfs_client on the list that matches the initialisation data
288 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
290 struct nfs_client *clp;
291 const struct sockaddr *sap = data->addr;
292 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
294 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
295 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
296 /* Don't match clients that failed to initialise properly */
297 if (clp->cl_cons_state < 0)
300 /* Different NFS versions cannot share the same nfs_client */
301 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
304 if (clp->cl_proto != data->proto)
306 /* Match nfsv4 minorversion */
307 if (clp->cl_minorversion != data->minorversion)
309 /* Match the full socket address */
310 if (!rpc_cmp_addr_port(sap, clap))
311 /* Match all xprt_switch full socket addresses */
312 if (IS_ERR(clp->cl_rpcclient) ||
313 !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
317 atomic_inc(&clp->cl_count);
324 * Return true if @clp is done initializing, false if still working on it.
326 * Use nfs_client_init_status to check if it was successful.
328 bool nfs_client_init_is_complete(const struct nfs_client *clp)
330 return clp->cl_cons_state <= NFS_CS_READY;
332 EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
335 * Return 0 if @clp was successfully initialized, -errno otherwise.
337 * This must be called *after* nfs_client_init_is_complete() returns true,
338 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
340 int nfs_client_init_status(const struct nfs_client *clp)
342 /* called without checking nfs_client_init_is_complete */
343 if (clp->cl_cons_state > NFS_CS_READY) {
347 return clp->cl_cons_state;
349 EXPORT_SYMBOL_GPL(nfs_client_init_status);
351 int nfs_wait_client_init_complete(const struct nfs_client *clp)
353 return wait_event_killable(nfs_client_active_wq,
354 nfs_client_init_is_complete(clp));
356 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
359 * Found an existing client. Make sure it's ready before returning.
361 static struct nfs_client *
362 nfs_found_client(const struct nfs_client_initdata *cl_init,
363 struct nfs_client *clp)
367 error = nfs_wait_client_init_complete(clp);
370 return ERR_PTR(-ERESTARTSYS);
373 if (clp->cl_cons_state < NFS_CS_READY) {
374 error = clp->cl_cons_state;
376 return ERR_PTR(error);
384 * Look up a client by IP address and protocol version
385 * - creates a new record if one doesn't yet exist
387 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
389 struct nfs_client *clp, *new = NULL;
390 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
391 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
393 if (cl_init->hostname == NULL) {
398 /* see if the client already exists */
400 spin_lock(&nn->nfs_client_lock);
402 clp = nfs_match_client(cl_init);
404 spin_unlock(&nn->nfs_client_lock);
406 new->rpc_ops->free_client(new);
407 return nfs_found_client(cl_init, clp);
410 list_add_tail(&new->cl_share_link,
411 &nn->nfs_client_list);
412 spin_unlock(&nn->nfs_client_lock);
413 new->cl_flags = cl_init->init_flags;
414 return rpc_ops->init_client(new, cl_init);
417 spin_unlock(&nn->nfs_client_lock);
419 new = rpc_ops->alloc_client(cl_init);
420 } while (!IS_ERR(new));
424 EXPORT_SYMBOL_GPL(nfs_get_client);
427 * Mark a server as ready or failed
429 void nfs_mark_client_ready(struct nfs_client *clp, int state)
432 clp->cl_cons_state = state;
433 wake_up_all(&nfs_client_active_wq);
435 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
438 * Initialise the timeout values for a connection
440 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
441 int timeo, int retrans)
443 to->to_initval = timeo * HZ / 10;
444 to->to_retries = retrans;
447 case XPRT_TRANSPORT_TCP:
448 case XPRT_TRANSPORT_RDMA:
449 if (retrans == NFS_UNSPEC_RETRANS)
450 to->to_retries = NFS_DEF_TCP_RETRANS;
451 if (timeo == NFS_UNSPEC_TIMEO || to->to_retries == 0)
452 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
453 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
454 to->to_initval = NFS_MAX_TCP_TIMEOUT;
455 to->to_increment = to->to_initval;
456 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
457 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
458 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
459 if (to->to_maxval < to->to_initval)
460 to->to_maxval = to->to_initval;
461 to->to_exponential = 0;
463 case XPRT_TRANSPORT_UDP:
464 if (retrans == NFS_UNSPEC_RETRANS)
465 to->to_retries = NFS_DEF_UDP_RETRANS;
466 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
467 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
468 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
469 to->to_initval = NFS_MAX_UDP_TIMEOUT;
470 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
471 to->to_exponential = 1;
477 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
480 * Create an RPC client handle
482 int nfs_create_rpc_client(struct nfs_client *clp,
483 const struct nfs_client_initdata *cl_init,
484 rpc_authflavor_t flavor)
486 struct rpc_clnt *clnt = NULL;
487 struct rpc_create_args args = {
489 .protocol = clp->cl_proto,
490 .address = (struct sockaddr *)&clp->cl_addr,
491 .addrsize = clp->cl_addrlen,
492 .timeout = cl_init->timeparms,
493 .servername = clp->cl_hostname,
494 .nodename = cl_init->nodename,
495 .program = &nfs_program,
496 .version = clp->rpc_ops->version,
497 .authflavor = flavor,
500 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
501 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
502 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
503 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
504 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
505 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
506 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
507 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
509 if (!IS_ERR(clp->cl_rpcclient))
512 clnt = rpc_create(&args);
514 dprintk("%s: cannot create RPC client. Error = %ld\n",
515 __func__, PTR_ERR(clnt));
516 return PTR_ERR(clnt);
519 clp->cl_rpcclient = clnt;
522 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
525 * Version 2 or 3 client destruction
527 static void nfs_destroy_server(struct nfs_server *server)
529 if (server->nlm_host)
530 nlmclnt_done(server->nlm_host);
534 * Version 2 or 3 lockd setup
536 static int nfs_start_lockd(struct nfs_server *server)
538 struct nlm_host *host;
539 struct nfs_client *clp = server->nfs_client;
540 struct nlmclnt_initdata nlm_init = {
541 .hostname = clp->cl_hostname,
542 .address = (struct sockaddr *)&clp->cl_addr,
543 .addrlen = clp->cl_addrlen,
544 .nfs_version = clp->rpc_ops->version,
545 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
548 .nlmclnt_ops = clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
551 if (nlm_init.nfs_version > 3)
553 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
554 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
557 switch (clp->cl_proto) {
559 nlm_init.protocol = IPPROTO_TCP;
561 case XPRT_TRANSPORT_UDP:
562 nlm_init.protocol = IPPROTO_UDP;
565 host = nlmclnt_init(&nlm_init);
567 return PTR_ERR(host);
569 server->nlm_host = host;
570 server->destroy = nfs_destroy_server;
575 * Create a general RPC client
577 int nfs_init_server_rpcclient(struct nfs_server *server,
578 const struct rpc_timeout *timeo,
579 rpc_authflavor_t pseudoflavour)
581 struct nfs_client *clp = server->nfs_client;
583 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
585 if (IS_ERR(server->client)) {
586 dprintk("%s: couldn't create rpc_client!\n", __func__);
587 return PTR_ERR(server->client);
590 memcpy(&server->client->cl_timeout_default,
592 sizeof(server->client->cl_timeout_default));
593 server->client->cl_timeout = &server->client->cl_timeout_default;
594 server->client->cl_softrtry = 0;
595 if (server->flags & NFS_MOUNT_SOFT)
596 server->client->cl_softrtry = 1;
600 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
603 * nfs_init_client - Initialise an NFS2 or NFS3 client
605 * @clp: nfs_client to initialise
606 * @cl_init: Initialisation parameters
608 * Returns pointer to an NFS client, or an ERR_PTR value.
610 struct nfs_client *nfs_init_client(struct nfs_client *clp,
611 const struct nfs_client_initdata *cl_init)
615 /* the client is already initialised */
616 if (clp->cl_cons_state == NFS_CS_READY)
620 * Create a client RPC handle for doing FSSTAT with UNIX auth only
621 * - RFC 2623, sec 2.3.2
623 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
624 nfs_mark_client_ready(clp, error == 0 ? NFS_CS_READY : error);
627 clp = ERR_PTR(error);
631 EXPORT_SYMBOL_GPL(nfs_init_client);
634 * Create a version 2 or 3 client
636 static int nfs_init_server(struct nfs_server *server,
637 const struct nfs_parsed_mount_data *data,
638 struct nfs_subversion *nfs_mod)
640 struct rpc_timeout timeparms;
641 struct nfs_client_initdata cl_init = {
642 .hostname = data->nfs_server.hostname,
643 .addr = (const struct sockaddr *)&data->nfs_server.address,
644 .addrlen = data->nfs_server.addrlen,
646 .proto = data->nfs_server.protocol,
648 .timeparms = &timeparms,
650 struct nfs_client *clp;
653 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
654 data->timeo, data->retrans);
655 if (data->flags & NFS_MOUNT_NORESVPORT)
656 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
658 /* Allocate or find a client reference we can use */
659 clp = nfs_get_client(&cl_init);
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;
709 server->nfs_client = NULL;
715 * Load up the server record from information gained in an fsinfo record
717 static void nfs_server_set_fsinfo(struct nfs_server *server,
718 struct nfs_fsinfo *fsinfo)
720 unsigned long max_rpc_payload;
722 /* Work out a lot of parameters */
723 if (server->rsize == 0)
724 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
725 if (server->wsize == 0)
726 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
728 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
729 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
730 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
731 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
733 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
734 if (server->rsize > max_rpc_payload)
735 server->rsize = max_rpc_payload;
736 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
737 server->rsize = NFS_MAX_FILE_IO_SIZE;
738 server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
740 if (server->wsize > max_rpc_payload)
741 server->wsize = max_rpc_payload;
742 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
743 server->wsize = NFS_MAX_FILE_IO_SIZE;
744 server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
746 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
748 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
749 if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
750 server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
751 if (server->dtsize > server->rsize)
752 server->dtsize = server->rsize;
754 if (server->flags & NFS_MOUNT_NOAC) {
755 server->acregmin = server->acregmax = 0;
756 server->acdirmin = server->acdirmax = 0;
759 server->maxfilesize = fsinfo->maxfilesize;
761 server->time_delta = fsinfo->time_delta;
763 server->clone_blksize = fsinfo->clone_blksize;
764 /* We're airborne Set socket buffersize */
765 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
769 * Probe filesystem information, including the FSID on v2/v3
771 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
773 struct nfs_fsinfo fsinfo;
774 struct nfs_client *clp = server->nfs_client;
777 if (clp->rpc_ops->set_capabilities != NULL) {
778 error = clp->rpc_ops->set_capabilities(server, mntfh);
783 fsinfo.fattr = fattr;
784 fsinfo.nlayouttypes = 0;
785 memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
786 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
790 nfs_server_set_fsinfo(server, &fsinfo);
792 /* Get some general file system info */
793 if (server->namelen == 0) {
794 struct nfs_pathconf pathinfo;
796 pathinfo.fattr = fattr;
797 nfs_fattr_init(fattr);
799 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
800 server->namelen = pathinfo.max_namelen;
805 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
808 * Copy useful information when duplicating a server record
810 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
812 target->flags = source->flags;
813 target->rsize = source->rsize;
814 target->wsize = source->wsize;
815 target->acregmin = source->acregmin;
816 target->acregmax = source->acregmax;
817 target->acdirmin = source->acdirmin;
818 target->acdirmax = source->acdirmax;
819 target->caps = source->caps;
820 target->options = source->options;
821 target->auth_info = source->auth_info;
822 target->port = source->port;
824 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
826 void nfs_server_insert_lists(struct nfs_server *server)
828 struct nfs_client *clp = server->nfs_client;
829 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
831 spin_lock(&nn->nfs_client_lock);
832 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
833 list_add_tail(&server->master_link, &nn->nfs_volume_list);
834 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
835 spin_unlock(&nn->nfs_client_lock);
838 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
840 void nfs_server_remove_lists(struct nfs_server *server)
842 struct nfs_client *clp = server->nfs_client;
847 nn = net_generic(clp->cl_net, nfs_net_id);
848 spin_lock(&nn->nfs_client_lock);
849 list_del_rcu(&server->client_link);
850 if (list_empty(&clp->cl_superblocks))
851 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
852 list_del(&server->master_link);
853 spin_unlock(&nn->nfs_client_lock);
857 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
860 * Allocate and initialise a server record
862 struct nfs_server *nfs_alloc_server(void)
864 struct nfs_server *server;
866 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
870 server->client = server->client_acl = ERR_PTR(-EINVAL);
872 /* Zero out the NFS state stuff */
873 INIT_LIST_HEAD(&server->client_link);
874 INIT_LIST_HEAD(&server->master_link);
875 INIT_LIST_HEAD(&server->delegations);
876 INIT_LIST_HEAD(&server->layouts);
877 INIT_LIST_HEAD(&server->state_owners_lru);
879 atomic_set(&server->active, 0);
881 server->io_stats = nfs_alloc_iostats();
882 if (!server->io_stats) {
887 ida_init(&server->openowner_id);
888 ida_init(&server->lockowner_id);
889 pnfs_init_server(server);
890 rpc_init_wait_queue(&server->uoc_rpcwaitq, "NFS UOC");
894 EXPORT_SYMBOL_GPL(nfs_alloc_server);
897 * Free up a server record
899 void nfs_free_server(struct nfs_server *server)
901 nfs_server_remove_lists(server);
903 if (server->destroy != NULL)
904 server->destroy(server);
906 if (!IS_ERR(server->client_acl))
907 rpc_shutdown_client(server->client_acl);
908 if (!IS_ERR(server->client))
909 rpc_shutdown_client(server->client);
911 nfs_put_client(server->nfs_client);
913 ida_destroy(&server->lockowner_id);
914 ida_destroy(&server->openowner_id);
915 nfs_free_iostats(server->io_stats);
917 nfs_release_automount_timer();
919 EXPORT_SYMBOL_GPL(nfs_free_server);
922 * Create a version 2 or 3 volume record
923 * - keyed on server and FSID
925 struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
926 struct nfs_subversion *nfs_mod)
928 struct nfs_server *server;
929 struct nfs_fattr *fattr;
932 server = nfs_alloc_server();
934 return ERR_PTR(-ENOMEM);
937 fattr = nfs_alloc_fattr();
941 /* Get a client representation */
942 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
946 /* Probe the root fh to retrieve its FSID */
947 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
950 if (server->nfs_client->rpc_ops->version == 3) {
951 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
952 server->namelen = NFS3_MAXNAMLEN;
953 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
954 server->caps |= NFS_CAP_READDIRPLUS;
956 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
957 server->namelen = NFS2_MAXNAMLEN;
960 if (!(fattr->valid & NFS_ATTR_FATTR)) {
961 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr, NULL);
963 dprintk("nfs_create_server: getattr error = %d\n", -error);
967 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
969 dprintk("Server FSID: %llx:%llx\n",
970 (unsigned long long) server->fsid.major,
971 (unsigned long long) server->fsid.minor);
973 nfs_server_insert_lists(server);
974 server->mount_time = jiffies;
975 nfs_free_fattr(fattr);
979 nfs_free_fattr(fattr);
980 nfs_free_server(server);
981 return ERR_PTR(error);
983 EXPORT_SYMBOL_GPL(nfs_create_server);
986 * Clone an NFS2, NFS3 or NFS4 server record
988 struct nfs_server *nfs_clone_server(struct nfs_server *source,
990 struct nfs_fattr *fattr,
991 rpc_authflavor_t flavor)
993 struct nfs_server *server;
994 struct nfs_fattr *fattr_fsinfo;
997 server = nfs_alloc_server();
999 return ERR_PTR(-ENOMEM);
1002 fattr_fsinfo = nfs_alloc_fattr();
1003 if (fattr_fsinfo == NULL)
1004 goto out_free_server;
1006 /* Copy data from the source */
1007 server->nfs_client = source->nfs_client;
1008 server->destroy = source->destroy;
1009 atomic_inc(&server->nfs_client->cl_count);
1010 nfs_server_copy_userdata(server, source);
1012 server->fsid = fattr->fsid;
1014 error = nfs_init_server_rpcclient(server,
1015 source->client->cl_timeout,
1018 goto out_free_server;
1020 /* probe the filesystem info for this server filesystem */
1021 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1023 goto out_free_server;
1025 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1026 server->namelen = NFS4_MAXNAMLEN;
1028 error = nfs_start_lockd(server);
1030 goto out_free_server;
1032 nfs_server_insert_lists(server);
1033 server->mount_time = jiffies;
1035 nfs_free_fattr(fattr_fsinfo);
1039 nfs_free_fattr(fattr_fsinfo);
1040 nfs_free_server(server);
1041 return ERR_PTR(error);
1043 EXPORT_SYMBOL_GPL(nfs_clone_server);
1045 void nfs_clients_init(struct net *net)
1047 struct nfs_net *nn = net_generic(net, nfs_net_id);
1049 INIT_LIST_HEAD(&nn->nfs_client_list);
1050 INIT_LIST_HEAD(&nn->nfs_volume_list);
1051 #if IS_ENABLED(CONFIG_NFS_V4)
1052 idr_init(&nn->cb_ident_idr);
1054 spin_lock_init(&nn->nfs_client_lock);
1055 nn->boot_time = ktime_get_real();
1058 #ifdef CONFIG_PROC_FS
1059 static int nfs_server_list_open(struct inode *inode, struct file *file);
1060 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1061 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1062 static void nfs_server_list_stop(struct seq_file *p, void *v);
1063 static int nfs_server_list_show(struct seq_file *m, void *v);
1065 static const struct seq_operations nfs_server_list_ops = {
1066 .start = nfs_server_list_start,
1067 .next = nfs_server_list_next,
1068 .stop = nfs_server_list_stop,
1069 .show = nfs_server_list_show,
1072 static const struct file_operations nfs_server_list_fops = {
1073 .open = nfs_server_list_open,
1075 .llseek = seq_lseek,
1076 .release = seq_release_net,
1079 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1080 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1081 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1082 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1083 static int nfs_volume_list_show(struct seq_file *m, void *v);
1085 static const struct seq_operations nfs_volume_list_ops = {
1086 .start = nfs_volume_list_start,
1087 .next = nfs_volume_list_next,
1088 .stop = nfs_volume_list_stop,
1089 .show = nfs_volume_list_show,
1092 static const struct file_operations nfs_volume_list_fops = {
1093 .open = nfs_volume_list_open,
1095 .llseek = seq_lseek,
1096 .release = seq_release_net,
1100 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1103 static int nfs_server_list_open(struct inode *inode, struct file *file)
1105 return seq_open_net(inode, file, &nfs_server_list_ops,
1106 sizeof(struct seq_net_private));
1110 * set up the iterator to start reading from the server list and return the first item
1112 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1113 __acquires(&nn->nfs_client_lock)
1115 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1117 /* lock the list against modification */
1118 spin_lock(&nn->nfs_client_lock);
1119 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1123 * move to next server
1125 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1127 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1129 return seq_list_next(v, &nn->nfs_client_list, pos);
1133 * clean up after reading from the transports list
1135 static void nfs_server_list_stop(struct seq_file *p, void *v)
1136 __releases(&nn->nfs_client_lock)
1138 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1140 spin_unlock(&nn->nfs_client_lock);
1144 * display a header line followed by a load of call lines
1146 static int nfs_server_list_show(struct seq_file *m, void *v)
1148 struct nfs_client *clp;
1149 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1151 /* display header on line 1 */
1152 if (v == &nn->nfs_client_list) {
1153 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1157 /* display one transport per line on subsequent lines */
1158 clp = list_entry(v, struct nfs_client, cl_share_link);
1160 /* Check if the client is initialized */
1161 if (clp->cl_cons_state != NFS_CS_READY)
1165 seq_printf(m, "v%u %s %s %3d %s\n",
1166 clp->rpc_ops->version,
1167 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1168 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1169 atomic_read(&clp->cl_count),
1177 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1179 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1181 return seq_open_net(inode, file, &nfs_volume_list_ops,
1182 sizeof(struct seq_net_private));
1186 * set up the iterator to start reading from the volume list and return the first item
1188 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1189 __acquires(&nn->nfs_client_lock)
1191 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1193 /* lock the list against modification */
1194 spin_lock(&nn->nfs_client_lock);
1195 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1199 * move to next volume
1201 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1203 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1205 return seq_list_next(v, &nn->nfs_volume_list, pos);
1209 * clean up after reading from the transports list
1211 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1212 __releases(&nn->nfs_client_lock)
1214 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1216 spin_unlock(&nn->nfs_client_lock);
1220 * display a header line followed by a load of call lines
1222 static int nfs_volume_list_show(struct seq_file *m, void *v)
1224 struct nfs_server *server;
1225 struct nfs_client *clp;
1226 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1227 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1228 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1230 /* display header on line 1 */
1231 if (v == &nn->nfs_volume_list) {
1232 seq_puts(m, "NV SERVER PORT DEV FSID"
1236 /* display one transport per line on subsequent lines */
1237 server = list_entry(v, struct nfs_server, master_link);
1238 clp = server->nfs_client;
1240 snprintf(dev, sizeof(dev), "%u:%u",
1241 MAJOR(server->s_dev), MINOR(server->s_dev));
1243 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1244 (unsigned long long) server->fsid.major,
1245 (unsigned long long) server->fsid.minor);
1248 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1249 clp->rpc_ops->version,
1250 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1251 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1254 nfs_server_fscache_state(server));
1260 int nfs_fs_proc_net_init(struct net *net)
1262 struct nfs_net *nn = net_generic(net, nfs_net_id);
1263 struct proc_dir_entry *p;
1265 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1266 if (!nn->proc_nfsfs)
1269 /* a file of servers with which we're dealing */
1270 p = proc_create("servers", S_IFREG|S_IRUGO,
1271 nn->proc_nfsfs, &nfs_server_list_fops);
1275 /* a file of volumes that we have mounted */
1276 p = proc_create("volumes", S_IFREG|S_IRUGO,
1277 nn->proc_nfsfs, &nfs_volume_list_fops);
1283 remove_proc_subtree("nfsfs", net->proc_net);
1288 void nfs_fs_proc_net_exit(struct net *net)
1290 remove_proc_subtree("nfsfs", net->proc_net);
1294 * initialise the /proc/fs/nfsfs/ directory
1296 int __init nfs_fs_proc_init(void)
1298 if (!proc_mkdir("fs/nfsfs", NULL))
1301 /* a file of servers with which we're dealing */
1302 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1305 /* a file of volumes that we have mounted */
1306 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1311 remove_proc_subtree("fs/nfsfs", NULL);
1317 * clean up the /proc/fs/nfsfs/ directory
1319 void nfs_fs_proc_exit(void)
1321 remove_proc_subtree("fs/nfsfs", NULL);
1324 #endif /* CONFIG_PROC_FS */