Linux Audio

Check our new training course

Loading...
v6.8
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/* client.c: NFS client sharing and management code
   3 *
   4 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
   5 * Written by David Howells (dhowells@redhat.com)
 
 
 
 
 
   6 */
   7
   8
   9#include <linux/module.h>
  10#include <linux/init.h>
  11#include <linux/sched.h>
  12#include <linux/time.h>
  13#include <linux/kernel.h>
  14#include <linux/mm.h>
  15#include <linux/string.h>
  16#include <linux/stat.h>
  17#include <linux/errno.h>
  18#include <linux/unistd.h>
  19#include <linux/sunrpc/addr.h>
  20#include <linux/sunrpc/clnt.h>
  21#include <linux/sunrpc/stats.h>
  22#include <linux/sunrpc/metrics.h>
  23#include <linux/sunrpc/xprtsock.h>
  24#include <linux/sunrpc/xprtrdma.h>
  25#include <linux/nfs_fs.h>
  26#include <linux/nfs_mount.h>
  27#include <linux/nfs4_mount.h>
  28#include <linux/lockd/bind.h>
  29#include <linux/seq_file.h>
  30#include <linux/mount.h>
  31#include <linux/vfs.h>
  32#include <linux/inet.h>
  33#include <linux/in6.h>
  34#include <linux/slab.h>
  35#include <linux/idr.h>
  36#include <net/ipv6.h>
  37#include <linux/nfs_xdr.h>
  38#include <linux/sunrpc/bc_xprt.h>
  39#include <linux/nsproxy.h>
  40#include <linux/pid_namespace.h>
  41
  42
  43#include "nfs4_fs.h"
  44#include "callback.h"
  45#include "delegation.h"
  46#include "iostat.h"
  47#include "internal.h"
  48#include "fscache.h"
  49#include "pnfs.h"
  50#include "nfs.h"
  51#include "netns.h"
  52#include "sysfs.h"
  53#include "nfs42.h"
  54
  55#define NFSDBG_FACILITY		NFSDBG_CLIENT
  56
  57static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
  58static DEFINE_SPINLOCK(nfs_version_lock);
  59static DEFINE_MUTEX(nfs_version_mutex);
  60static LIST_HEAD(nfs_versions);
  61
  62/*
  63 * RPC cruft for NFS
  64 */
  65static const struct rpc_version *nfs_version[5] = {
  66	[2] = NULL,
  67	[3] = NULL,
  68	[4] = NULL,
  69};
  70
  71const struct rpc_program nfs_program = {
  72	.name			= "nfs",
  73	.number			= NFS_PROGRAM,
  74	.nrvers			= ARRAY_SIZE(nfs_version),
  75	.version		= nfs_version,
  76	.stats			= &nfs_rpcstat,
  77	.pipe_dir_name		= NFS_PIPE_DIRNAME,
  78};
  79
  80struct rpc_stat nfs_rpcstat = {
  81	.program		= &nfs_program
  82};
  83
  84static struct nfs_subversion *find_nfs_version(unsigned int version)
  85{
  86	struct nfs_subversion *nfs;
  87	spin_lock(&nfs_version_lock);
  88
  89	list_for_each_entry(nfs, &nfs_versions, list) {
  90		if (nfs->rpc_ops->version == version) {
  91			spin_unlock(&nfs_version_lock);
  92			return nfs;
  93		}
  94	}
  95
  96	spin_unlock(&nfs_version_lock);
  97	return ERR_PTR(-EPROTONOSUPPORT);
  98}
  99
 100struct nfs_subversion *get_nfs_version(unsigned int version)
 101{
 102	struct nfs_subversion *nfs = find_nfs_version(version);
 103
 104	if (IS_ERR(nfs)) {
 105		mutex_lock(&nfs_version_mutex);
 106		request_module("nfsv%d", version);
 107		nfs = find_nfs_version(version);
 108		mutex_unlock(&nfs_version_mutex);
 109	}
 110
 111	if (!IS_ERR(nfs) && !try_module_get(nfs->owner))
 112		return ERR_PTR(-EAGAIN);
 113	return nfs;
 114}
 115
 116void put_nfs_version(struct nfs_subversion *nfs)
 117{
 118	module_put(nfs->owner);
 119}
 120
 121void register_nfs_version(struct nfs_subversion *nfs)
 122{
 123	spin_lock(&nfs_version_lock);
 124
 125	list_add(&nfs->list, &nfs_versions);
 126	nfs_version[nfs->rpc_ops->version] = nfs->rpc_vers;
 127
 128	spin_unlock(&nfs_version_lock);
 129}
 130EXPORT_SYMBOL_GPL(register_nfs_version);
 131
 132void unregister_nfs_version(struct nfs_subversion *nfs)
 133{
 134	spin_lock(&nfs_version_lock);
 135
 136	nfs_version[nfs->rpc_ops->version] = NULL;
 137	list_del(&nfs->list);
 138
 139	spin_unlock(&nfs_version_lock);
 140}
 141EXPORT_SYMBOL_GPL(unregister_nfs_version);
 142
 143/*
 144 * Allocate a shared client record
 145 *
 146 * Since these are allocated/deallocated very rarely, we don't
 147 * bother putting them in a slab cache...
 148 */
 149struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
 150{
 151	struct nfs_client *clp;
 
 152	int err = -ENOMEM;
 153
 154	if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
 155		goto error_0;
 156
 157	clp->cl_minorversion = cl_init->minorversion;
 158	clp->cl_nfs_mod = cl_init->nfs_mod;
 159	if (!try_module_get(clp->cl_nfs_mod->owner))
 160		goto error_dealloc;
 161
 162	clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
 163
 164	refcount_set(&clp->cl_count, 1);
 165	clp->cl_cons_state = NFS_CS_INITING;
 166
 167	memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
 168	clp->cl_addrlen = cl_init->addrlen;
 169
 170	if (cl_init->hostname) {
 171		err = -ENOMEM;
 172		clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
 173		if (!clp->cl_hostname)
 174			goto error_cleanup;
 175	}
 176
 177	INIT_LIST_HEAD(&clp->cl_superblocks);
 178	clp->cl_rpcclient = ERR_PTR(-EINVAL);
 179
 180	clp->cl_flags = cl_init->init_flags;
 181	clp->cl_proto = cl_init->proto;
 182	clp->cl_nconnect = cl_init->nconnect;
 183	clp->cl_max_connect = cl_init->max_connect ? cl_init->max_connect : 1;
 184	clp->cl_net = get_net(cl_init->net);
 185
 186	clp->cl_principal = "*";
 187	clp->cl_xprtsec = cl_init->xprtsec;
 
 
 
 188	return clp;
 189
 190error_cleanup:
 191	put_nfs_version(clp->cl_nfs_mod);
 192error_dealloc:
 193	kfree(clp);
 194error_0:
 195	return ERR_PTR(err);
 196}
 197EXPORT_SYMBOL_GPL(nfs_alloc_client);
 198
 199#if IS_ENABLED(CONFIG_NFS_V4)
 200static void nfs_cleanup_cb_ident_idr(struct net *net)
 201{
 202	struct nfs_net *nn = net_generic(net, nfs_net_id);
 203
 204	idr_destroy(&nn->cb_ident_idr);
 205}
 206
 207/* nfs_client_lock held */
 208static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
 209{
 210	struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
 211
 212	if (clp->cl_cb_ident)
 213		idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
 214}
 215
 216static void pnfs_init_server(struct nfs_server *server)
 217{
 218	rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
 219}
 220
 221#else
 222static void nfs_cleanup_cb_ident_idr(struct net *net)
 223{
 224}
 225
 226static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
 227{
 228}
 229
 230static void pnfs_init_server(struct nfs_server *server)
 231{
 232}
 233
 234#endif /* CONFIG_NFS_V4 */
 235
 236/*
 237 * Destroy a shared client record
 238 */
 239void nfs_free_client(struct nfs_client *clp)
 240{
 
 
 
 
 241	/* -EIO all pending I/O */
 242	if (!IS_ERR(clp->cl_rpcclient))
 243		rpc_shutdown_client(clp->cl_rpcclient);
 244
 
 
 
 245	put_net(clp->cl_net);
 246	put_nfs_version(clp->cl_nfs_mod);
 247	kfree(clp->cl_hostname);
 248	kfree(clp->cl_acceptor);
 249	kfree_rcu(clp, rcu);
 
 
 250}
 251EXPORT_SYMBOL_GPL(nfs_free_client);
 252
 253/*
 254 * Release a reference to a shared client record
 255 */
 256void nfs_put_client(struct nfs_client *clp)
 257{
 258	struct nfs_net *nn;
 259
 260	if (!clp)
 261		return;
 262
 
 263	nn = net_generic(clp->cl_net, nfs_net_id);
 264
 265	if (refcount_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
 266		list_del(&clp->cl_share_link);
 267		nfs_cb_idr_remove_locked(clp);
 268		spin_unlock(&nn->nfs_client_lock);
 269
 270		WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
 271
 272		clp->rpc_ops->free_client(clp);
 273	}
 274}
 275EXPORT_SYMBOL_GPL(nfs_put_client);
 276
 277/*
 278 * Find an nfs_client on the list that matches the initialisation data
 279 * that is supplied.
 280 */
 281static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
 282{
 283	struct nfs_client *clp;
 284	const struct sockaddr *sap = (struct sockaddr *)data->addr;
 285	struct nfs_net *nn = net_generic(data->net, nfs_net_id);
 286	int error;
 287
 288again:
 289	list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
 290	        const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
 291		/* Don't match clients that failed to initialise properly */
 292		if (clp->cl_cons_state < 0)
 293			continue;
 294
 295		/* If a client is still initializing then we need to wait */
 296		if (clp->cl_cons_state > NFS_CS_READY) {
 297			refcount_inc(&clp->cl_count);
 298			spin_unlock(&nn->nfs_client_lock);
 299			error = nfs_wait_client_init_complete(clp);
 300			nfs_put_client(clp);
 301			spin_lock(&nn->nfs_client_lock);
 302			if (error < 0)
 303				return ERR_PTR(error);
 304			goto again;
 305		}
 306
 307		/* Different NFS versions cannot share the same nfs_client */
 308		if (clp->rpc_ops != data->nfs_mod->rpc_ops)
 309			continue;
 310
 311		if (clp->cl_proto != data->proto)
 312			continue;
 313		/* Match nfsv4 minorversion */
 314		if (clp->cl_minorversion != data->minorversion)
 315			continue;
 316
 317		/* Match request for a dedicated DS */
 318		if (test_bit(NFS_CS_DS, &data->init_flags) !=
 319		    test_bit(NFS_CS_DS, &clp->cl_flags))
 320			continue;
 321
 322		/* Match the full socket address */
 323		if (!rpc_cmp_addr_port(sap, clap))
 324			/* Match all xprt_switch full socket addresses */
 325			if (IS_ERR(clp->cl_rpcclient) ||
 326                            !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
 327							   sap))
 328				continue;
 329
 330		/* Match the xprt security policy */
 331		if (clp->cl_xprtsec.policy != data->xprtsec.policy)
 332			continue;
 333
 334		refcount_inc(&clp->cl_count);
 335		return clp;
 336	}
 337	return NULL;
 338}
 339
 340/*
 341 * Return true if @clp is done initializing, false if still working on it.
 342 *
 343 * Use nfs_client_init_status to check if it was successful.
 344 */
 345bool nfs_client_init_is_complete(const struct nfs_client *clp)
 346{
 347	return clp->cl_cons_state <= NFS_CS_READY;
 348}
 349EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
 350
 351/*
 352 * Return 0 if @clp was successfully initialized, -errno otherwise.
 353 *
 354 * This must be called *after* nfs_client_init_is_complete() returns true,
 355 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
 356 */
 357int nfs_client_init_status(const struct nfs_client *clp)
 358{
 359	/* called without checking nfs_client_init_is_complete */
 360	if (clp->cl_cons_state > NFS_CS_READY) {
 361		WARN_ON_ONCE(1);
 362		return -EINVAL;
 363	}
 364	return clp->cl_cons_state;
 365}
 366EXPORT_SYMBOL_GPL(nfs_client_init_status);
 367
 368int nfs_wait_client_init_complete(const struct nfs_client *clp)
 369{
 370	return wait_event_killable(nfs_client_active_wq,
 371			nfs_client_init_is_complete(clp));
 372}
 373EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
 374
 375/*
 376 * Found an existing client.  Make sure it's ready before returning.
 377 */
 378static struct nfs_client *
 379nfs_found_client(const struct nfs_client_initdata *cl_init,
 380		 struct nfs_client *clp)
 381{
 382	int error;
 383
 384	error = nfs_wait_client_init_complete(clp);
 385	if (error < 0) {
 386		nfs_put_client(clp);
 387		return ERR_PTR(-ERESTARTSYS);
 388	}
 389
 390	if (clp->cl_cons_state < NFS_CS_READY) {
 391		error = clp->cl_cons_state;
 392		nfs_put_client(clp);
 393		return ERR_PTR(error);
 394	}
 395
 396	smp_rmb();
 
 
 
 397	return clp;
 398}
 399
 400/*
 401 * Look up a client by IP address and protocol version
 402 * - creates a new record if one doesn't yet exist
 403 */
 404struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
 405{
 406	struct nfs_client *clp, *new = NULL;
 407	struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
 408	const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
 409
 410	if (cl_init->hostname == NULL) {
 411		WARN_ON(1);
 412		return ERR_PTR(-EINVAL);
 413	}
 414
 
 
 
 415	/* see if the client already exists */
 416	do {
 417		spin_lock(&nn->nfs_client_lock);
 418
 419		clp = nfs_match_client(cl_init);
 420		if (clp) {
 421			spin_unlock(&nn->nfs_client_lock);
 422			if (new)
 423				new->rpc_ops->free_client(new);
 424			if (IS_ERR(clp))
 425				return clp;
 426			return nfs_found_client(cl_init, clp);
 427		}
 428		if (new) {
 429			list_add_tail(&new->cl_share_link,
 430					&nn->nfs_client_list);
 431			spin_unlock(&nn->nfs_client_lock);
 
 432			return rpc_ops->init_client(new, cl_init);
 433		}
 434
 435		spin_unlock(&nn->nfs_client_lock);
 436
 437		new = rpc_ops->alloc_client(cl_init);
 438	} while (!IS_ERR(new));
 439
 
 
 440	return new;
 441}
 442EXPORT_SYMBOL_GPL(nfs_get_client);
 443
 444/*
 445 * Mark a server as ready or failed
 446 */
 447void nfs_mark_client_ready(struct nfs_client *clp, int state)
 448{
 449	smp_wmb();
 450	clp->cl_cons_state = state;
 451	wake_up_all(&nfs_client_active_wq);
 452}
 453EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
 454
 455/*
 456 * Initialise the timeout values for a connection
 457 */
 458void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
 459				    int timeo, int retrans)
 460{
 461	to->to_initval = timeo * HZ / 10;
 462	to->to_retries = retrans;
 463
 464	switch (proto) {
 465	case XPRT_TRANSPORT_TCP:
 466	case XPRT_TRANSPORT_TCP_TLS:
 467	case XPRT_TRANSPORT_RDMA:
 468		if (retrans == NFS_UNSPEC_RETRANS)
 469			to->to_retries = NFS_DEF_TCP_RETRANS;
 470		if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
 471			to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
 472		if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
 473			to->to_initval = NFS_MAX_TCP_TIMEOUT;
 474		to->to_increment = to->to_initval;
 475		to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
 476		if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
 477			to->to_maxval = NFS_MAX_TCP_TIMEOUT;
 478		if (to->to_maxval < to->to_initval)
 479			to->to_maxval = to->to_initval;
 480		to->to_exponential = 0;
 481		break;
 482	case XPRT_TRANSPORT_UDP:
 483		if (retrans == NFS_UNSPEC_RETRANS)
 484			to->to_retries = NFS_DEF_UDP_RETRANS;
 485		if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
 486			to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
 487		if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
 488			to->to_initval = NFS_MAX_UDP_TIMEOUT;
 489		to->to_maxval = NFS_MAX_UDP_TIMEOUT;
 490		to->to_exponential = 1;
 491		break;
 492	default:
 493		BUG();
 494	}
 495}
 496EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
 497
 498/*
 499 * Create an RPC client handle
 500 */
 501int nfs_create_rpc_client(struct nfs_client *clp,
 502			  const struct nfs_client_initdata *cl_init,
 503			  rpc_authflavor_t flavor)
 504{
 505	struct rpc_clnt		*clnt = NULL;
 506	struct rpc_create_args args = {
 507		.net		= clp->cl_net,
 508		.protocol	= clp->cl_proto,
 509		.nconnect	= clp->cl_nconnect,
 510		.address	= (struct sockaddr *)&clp->cl_addr,
 511		.addrsize	= clp->cl_addrlen,
 512		.timeout	= cl_init->timeparms,
 513		.servername	= clp->cl_hostname,
 514		.nodename	= cl_init->nodename,
 515		.program	= &nfs_program,
 516		.version	= clp->rpc_ops->version,
 517		.authflavor	= flavor,
 518		.cred		= cl_init->cred,
 519		.xprtsec	= cl_init->xprtsec,
 520		.connect_timeout = cl_init->connect_timeout,
 521		.reconnect_timeout = cl_init->reconnect_timeout,
 522	};
 523
 524	if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
 525		args.flags |= RPC_CLNT_CREATE_DISCRTRY;
 526	if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
 527		args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
 528	if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
 529		args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
 530	if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
 531		args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
 532	if (test_bit(NFS_CS_NOPING, &clp->cl_flags))
 533		args.flags |= RPC_CLNT_CREATE_NOPING;
 534	if (test_bit(NFS_CS_REUSEPORT, &clp->cl_flags))
 535		args.flags |= RPC_CLNT_CREATE_REUSEPORT;
 536
 537	if (!IS_ERR(clp->cl_rpcclient))
 538		return 0;
 539
 540	clnt = rpc_create(&args);
 541	if (IS_ERR(clnt)) {
 542		dprintk("%s: cannot create RPC client. Error = %ld\n",
 543				__func__, PTR_ERR(clnt));
 544		return PTR_ERR(clnt);
 545	}
 546
 547	clnt->cl_principal = clp->cl_principal;
 548	clp->cl_rpcclient = clnt;
 549	clnt->cl_max_connect = clp->cl_max_connect;
 550	return 0;
 551}
 552EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
 553
 554/*
 555 * Version 2 or 3 client destruction
 556 */
 557static void nfs_destroy_server(struct nfs_server *server)
 558{
 559	if (server->nlm_host)
 560		nlmclnt_done(server->nlm_host);
 561}
 562
 563/*
 564 * Version 2 or 3 lockd setup
 565 */
 566static int nfs_start_lockd(struct nfs_server *server)
 567{
 568	struct nlm_host *host;
 569	struct nfs_client *clp = server->nfs_client;
 570	struct nlmclnt_initdata nlm_init = {
 571		.hostname	= clp->cl_hostname,
 572		.address	= (struct sockaddr *)&clp->cl_addr,
 573		.addrlen	= clp->cl_addrlen,
 574		.nfs_version	= clp->rpc_ops->version,
 575		.noresvport	= server->flags & NFS_MOUNT_NORESVPORT ?
 576					1 : 0,
 577		.net		= clp->cl_net,
 578		.nlmclnt_ops 	= clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
 579		.cred		= server->cred,
 580	};
 581
 582	if (nlm_init.nfs_version > 3)
 583		return 0;
 584	if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
 585			(server->flags & NFS_MOUNT_LOCAL_FCNTL))
 586		return 0;
 587
 588	switch (clp->cl_proto) {
 589		default:
 590			nlm_init.protocol = IPPROTO_TCP;
 591			break;
 592#ifndef CONFIG_NFS_DISABLE_UDP_SUPPORT
 593		case XPRT_TRANSPORT_UDP:
 594			nlm_init.protocol = IPPROTO_UDP;
 595#endif
 596	}
 597
 598	host = nlmclnt_init(&nlm_init);
 599	if (IS_ERR(host))
 600		return PTR_ERR(host);
 601
 602	server->nlm_host = host;
 603	server->destroy = nfs_destroy_server;
 604	nfs_sysfs_link_rpc_client(server, nlmclnt_rpc_clnt(host), NULL);
 605	return 0;
 606}
 607
 608/*
 609 * Create a general RPC client
 610 */
 611int nfs_init_server_rpcclient(struct nfs_server *server,
 612		const struct rpc_timeout *timeo,
 613		rpc_authflavor_t pseudoflavour)
 614{
 615	struct nfs_client *clp = server->nfs_client;
 616
 617	server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
 618							pseudoflavour);
 619	if (IS_ERR(server->client)) {
 620		dprintk("%s: couldn't create rpc_client!\n", __func__);
 621		return PTR_ERR(server->client);
 622	}
 623
 624	memcpy(&server->client->cl_timeout_default,
 625			timeo,
 626			sizeof(server->client->cl_timeout_default));
 627	server->client->cl_timeout = &server->client->cl_timeout_default;
 628	server->client->cl_softrtry = 0;
 629	if (server->flags & NFS_MOUNT_SOFTERR)
 630		server->client->cl_softerr = 1;
 631	if (server->flags & NFS_MOUNT_SOFT)
 632		server->client->cl_softrtry = 1;
 633
 634	nfs_sysfs_link_rpc_client(server, server->client, NULL);
 635	return 0;
 636}
 637EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
 638
 639/**
 640 * nfs_init_client - Initialise an NFS2 or NFS3 client
 641 *
 642 * @clp: nfs_client to initialise
 643 * @cl_init: Initialisation parameters
 644 *
 645 * Returns pointer to an NFS client, or an ERR_PTR value.
 646 */
 647struct nfs_client *nfs_init_client(struct nfs_client *clp,
 648				   const struct nfs_client_initdata *cl_init)
 649{
 650	int error;
 651
 652	/* the client is already initialised */
 653	if (clp->cl_cons_state == NFS_CS_READY)
 
 654		return clp;
 
 655
 656	/*
 657	 * Create a client RPC handle for doing FSSTAT with UNIX auth only
 658	 * - RFC 2623, sec 2.3.2
 659	 */
 660	error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
 661	nfs_mark_client_ready(clp, error == 0 ? NFS_CS_READY : error);
 662	if (error < 0) {
 663		nfs_put_client(clp);
 664		clp = ERR_PTR(error);
 665	}
 666	return clp;
 
 
 
 
 
 
 667}
 668EXPORT_SYMBOL_GPL(nfs_init_client);
 669
 670/*
 671 * Create a version 2 or 3 client
 672 */
 673static int nfs_init_server(struct nfs_server *server,
 674			   const struct fs_context *fc)
 
 675{
 676	const struct nfs_fs_context *ctx = nfs_fc2context(fc);
 677	struct rpc_timeout timeparms;
 678	struct nfs_client_initdata cl_init = {
 679		.hostname = ctx->nfs_server.hostname,
 680		.addr = &ctx->nfs_server._address,
 681		.addrlen = ctx->nfs_server.addrlen,
 682		.nfs_mod = ctx->nfs_mod,
 683		.proto = ctx->nfs_server.protocol,
 684		.net = fc->net_ns,
 685		.timeparms = &timeparms,
 686		.cred = server->cred,
 687		.nconnect = ctx->nfs_server.nconnect,
 688		.init_flags = (1UL << NFS_CS_REUSEPORT),
 689		.xprtsec = ctx->xprtsec,
 690	};
 691	struct nfs_client *clp;
 692	int error;
 693
 694	nfs_init_timeout_values(&timeparms, ctx->nfs_server.protocol,
 695				ctx->timeo, ctx->retrans);
 696	if (ctx->flags & NFS_MOUNT_NORESVPORT)
 
 
 697		set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
 698
 699	/* Allocate or find a client reference we can use */
 700	clp = nfs_get_client(&cl_init);
 701	if (IS_ERR(clp))
 
 702		return PTR_ERR(clp);
 
 703
 704	server->nfs_client = clp;
 705	nfs_sysfs_add_server(server);
 706	nfs_sysfs_link_rpc_client(server, clp->cl_rpcclient, "_state");
 707
 708	/* Initialise the client representation from the mount data */
 709	server->flags = ctx->flags;
 710	server->options = ctx->options;
 711	server->caps |= NFS_CAP_HARDLINKS | NFS_CAP_SYMLINKS;
 712
 713	switch (clp->rpc_ops->version) {
 714	case 2:
 715		server->fattr_valid = NFS_ATTR_FATTR_V2;
 716		break;
 717	case 3:
 718		server->fattr_valid = NFS_ATTR_FATTR_V3;
 719		break;
 720	default:
 721		server->fattr_valid = NFS_ATTR_FATTR_V4;
 722	}
 723
 724	if (ctx->rsize)
 725		server->rsize = nfs_io_size(ctx->rsize, clp->cl_proto);
 726	if (ctx->wsize)
 727		server->wsize = nfs_io_size(ctx->wsize, clp->cl_proto);
 728
 729	server->acregmin = ctx->acregmin * HZ;
 730	server->acregmax = ctx->acregmax * HZ;
 731	server->acdirmin = ctx->acdirmin * HZ;
 732	server->acdirmax = ctx->acdirmax * HZ;
 733
 734	/* Start lockd here, before we might error out */
 735	error = nfs_start_lockd(server);
 736	if (error < 0)
 737		goto error;
 738
 739	server->port = ctx->nfs_server.port;
 740	server->auth_info = ctx->auth_info;
 741
 742	error = nfs_init_server_rpcclient(server, &timeparms,
 743					  ctx->selected_flavor);
 744	if (error < 0)
 745		goto error;
 746
 747	/* Preserve the values of mount_server-related mount options */
 748	if (ctx->mount_server.addrlen) {
 749		memcpy(&server->mountd_address, &ctx->mount_server.address,
 750			ctx->mount_server.addrlen);
 751		server->mountd_addrlen = ctx->mount_server.addrlen;
 752	}
 753	server->mountd_version = ctx->mount_server.version;
 754	server->mountd_port = ctx->mount_server.port;
 755	server->mountd_protocol = ctx->mount_server.protocol;
 756
 757	server->namelen  = ctx->namlen;
 
 758	return 0;
 759
 760error:
 761	server->nfs_client = NULL;
 762	nfs_put_client(clp);
 
 763	return error;
 764}
 765
 766/*
 767 * Load up the server record from information gained in an fsinfo record
 768 */
 769static void nfs_server_set_fsinfo(struct nfs_server *server,
 770				  struct nfs_fsinfo *fsinfo)
 771{
 772	struct nfs_client *clp = server->nfs_client;
 773	unsigned long max_rpc_payload, raw_max_rpc_payload;
 774
 775	/* Work out a lot of parameters */
 776	if (server->rsize == 0)
 777		server->rsize = nfs_io_size(fsinfo->rtpref, clp->cl_proto);
 778	if (server->wsize == 0)
 779		server->wsize = nfs_io_size(fsinfo->wtpref, clp->cl_proto);
 780
 781	if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
 782		server->rsize = nfs_io_size(fsinfo->rtmax, clp->cl_proto);
 783	if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
 784		server->wsize = nfs_io_size(fsinfo->wtmax, clp->cl_proto);
 785
 786	raw_max_rpc_payload = rpc_max_payload(server->client);
 787	max_rpc_payload = nfs_block_size(raw_max_rpc_payload, NULL);
 788
 
 789	if (server->rsize > max_rpc_payload)
 790		server->rsize = max_rpc_payload;
 791	if (server->rsize > NFS_MAX_FILE_IO_SIZE)
 792		server->rsize = NFS_MAX_FILE_IO_SIZE;
 793	server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
 794
 
 
 
 795	if (server->wsize > max_rpc_payload)
 796		server->wsize = max_rpc_payload;
 797	if (server->wsize > NFS_MAX_FILE_IO_SIZE)
 798		server->wsize = NFS_MAX_FILE_IO_SIZE;
 799	server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
 800
 801	server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
 802
 803	server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
 804	if (server->dtsize > NFS_MAX_FILE_IO_SIZE)
 805		server->dtsize = NFS_MAX_FILE_IO_SIZE;
 806	if (server->dtsize > server->rsize)
 807		server->dtsize = server->rsize;
 808
 809	if (server->flags & NFS_MOUNT_NOAC) {
 810		server->acregmin = server->acregmax = 0;
 811		server->acdirmin = server->acdirmax = 0;
 812	}
 813
 814	server->maxfilesize = fsinfo->maxfilesize;
 815
 816	server->time_delta = fsinfo->time_delta;
 817	server->change_attr_type = fsinfo->change_attr_type;
 818
 819	server->clone_blksize = fsinfo->clone_blksize;
 820	/* We're airborne Set socket buffersize */
 821	rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
 822
 823#ifdef CONFIG_NFS_V4_2
 824	/*
 825	 * Defaults until limited by the session parameters.
 826	 */
 827	server->gxasize = min_t(unsigned int, raw_max_rpc_payload,
 828				XATTR_SIZE_MAX);
 829	server->sxasize = min_t(unsigned int, raw_max_rpc_payload,
 830				XATTR_SIZE_MAX);
 831	server->lxasize = min_t(unsigned int, raw_max_rpc_payload,
 832				nfs42_listxattr_xdrsize(XATTR_LIST_MAX));
 833
 834	if (fsinfo->xattr_support)
 835		server->caps |= NFS_CAP_XATTR;
 836#endif
 837}
 838
 839/*
 840 * Probe filesystem information, including the FSID on v2/v3
 841 */
 842static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
 843{
 844	struct nfs_fsinfo fsinfo;
 845	struct nfs_client *clp = server->nfs_client;
 846	int error;
 847
 
 
 848	if (clp->rpc_ops->set_capabilities != NULL) {
 849		error = clp->rpc_ops->set_capabilities(server, mntfh);
 850		if (error < 0)
 851			return error;
 852	}
 853
 854	fsinfo.fattr = fattr;
 855	fsinfo.nlayouttypes = 0;
 856	memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
 857	error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
 858	if (error < 0)
 859		return error;
 860
 861	nfs_server_set_fsinfo(server, &fsinfo);
 862
 863	/* Get some general file system info */
 864	if (server->namelen == 0) {
 865		struct nfs_pathconf pathinfo;
 866
 867		pathinfo.fattr = fattr;
 868		nfs_fattr_init(fattr);
 869
 870		if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
 871			server->namelen = pathinfo.max_namelen;
 872	}
 873
 874	if (clp->rpc_ops->discover_trunking != NULL &&
 875			(server->caps & NFS_CAP_FS_LOCATIONS &&
 876			 (server->flags & NFS_MOUNT_TRUNK_DISCOVERY))) {
 877		error = clp->rpc_ops->discover_trunking(server, mntfh);
 878		if (error < 0)
 879			return error;
 880	}
 881
 882	return 0;
 883}
 884
 885/*
 886 * Grab the destination's particulars, including lease expiry time.
 887 *
 888 * Returns zero if probe succeeded and retrieved FSID matches the FSID
 889 * we have cached.
 890 */
 891int nfs_probe_server(struct nfs_server *server, struct nfs_fh *mntfh)
 892{
 893	struct nfs_fattr *fattr;
 894	int error;
 895
 896	fattr = nfs_alloc_fattr();
 897	if (fattr == NULL)
 898		return -ENOMEM;
 899
 900	/* Sanity: the probe won't work if the destination server
 901	 * does not recognize the migrated FH. */
 902	error = nfs_probe_fsinfo(server, mntfh, fattr);
 903
 904	nfs_free_fattr(fattr);
 905	return error;
 906}
 907EXPORT_SYMBOL_GPL(nfs_probe_server);
 908
 909/*
 910 * Copy useful information when duplicating a server record
 911 */
 912void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
 913{
 914	target->flags = source->flags;
 915	target->rsize = source->rsize;
 916	target->wsize = source->wsize;
 917	target->acregmin = source->acregmin;
 918	target->acregmax = source->acregmax;
 919	target->acdirmin = source->acdirmin;
 920	target->acdirmax = source->acdirmax;
 921	target->caps = source->caps;
 922	target->options = source->options;
 923	target->auth_info = source->auth_info;
 924	target->port = source->port;
 925}
 926EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
 927
 928void nfs_server_insert_lists(struct nfs_server *server)
 929{
 930	struct nfs_client *clp = server->nfs_client;
 931	struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
 932
 933	spin_lock(&nn->nfs_client_lock);
 934	list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
 935	list_add_tail(&server->master_link, &nn->nfs_volume_list);
 936	clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
 937	spin_unlock(&nn->nfs_client_lock);
 938
 939}
 940EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
 941
 942void nfs_server_remove_lists(struct nfs_server *server)
 943{
 944	struct nfs_client *clp = server->nfs_client;
 945	struct nfs_net *nn;
 946
 947	if (clp == NULL)
 948		return;
 949	nn = net_generic(clp->cl_net, nfs_net_id);
 950	spin_lock(&nn->nfs_client_lock);
 951	list_del_rcu(&server->client_link);
 952	if (list_empty(&clp->cl_superblocks))
 953		set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
 954	list_del(&server->master_link);
 955	spin_unlock(&nn->nfs_client_lock);
 956
 957	synchronize_rcu();
 958}
 959EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
 960
 961static DEFINE_IDA(s_sysfs_ids);
 962
 963/*
 964 * Allocate and initialise a server record
 965 */
 966struct nfs_server *nfs_alloc_server(void)
 967{
 968	struct nfs_server *server;
 969
 970	server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
 971	if (!server)
 972		return NULL;
 973
 974	server->s_sysfs_id = ida_alloc(&s_sysfs_ids, GFP_KERNEL);
 975	if (server->s_sysfs_id < 0) {
 976		kfree(server);
 977		return NULL;
 978	}
 979
 980	server->client = server->client_acl = ERR_PTR(-EINVAL);
 981
 982	/* Zero out the NFS state stuff */
 983	INIT_LIST_HEAD(&server->client_link);
 984	INIT_LIST_HEAD(&server->master_link);
 985	INIT_LIST_HEAD(&server->delegations);
 986	INIT_LIST_HEAD(&server->layouts);
 987	INIT_LIST_HEAD(&server->state_owners_lru);
 988	INIT_LIST_HEAD(&server->ss_copies);
 989
 990	atomic_set(&server->active, 0);
 991
 992	server->io_stats = nfs_alloc_iostats();
 993	if (!server->io_stats) {
 994		kfree(server);
 995		return NULL;
 996	}
 997
 998	server->change_attr_type = NFS4_CHANGE_TYPE_IS_UNDEFINED;
 
 
 
 
 999
1000	ida_init(&server->openowner_id);
1001	ida_init(&server->lockowner_id);
1002	pnfs_init_server(server);
1003	rpc_init_wait_queue(&server->uoc_rpcwaitq, "NFS UOC");
1004
1005	return server;
1006}
1007EXPORT_SYMBOL_GPL(nfs_alloc_server);
1008
1009static void delayed_free(struct rcu_head *p)
1010{
1011	struct nfs_server *server = container_of(p, struct nfs_server, rcu);
1012
1013	nfs_free_iostats(server->io_stats);
1014	kfree(server);
1015}
1016
1017/*
1018 * Free up a server record
1019 */
1020void nfs_free_server(struct nfs_server *server)
1021{
 
 
1022	nfs_server_remove_lists(server);
1023
1024	if (server->destroy != NULL)
1025		server->destroy(server);
1026
1027	if (!IS_ERR(server->client_acl))
1028		rpc_shutdown_client(server->client_acl);
1029	if (!IS_ERR(server->client))
1030		rpc_shutdown_client(server->client);
1031
1032	nfs_put_client(server->nfs_client);
1033
1034	if (server->kobj.state_initialized) {
1035		nfs_sysfs_remove_server(server);
1036		kobject_put(&server->kobj);
1037	}
1038	ida_free(&s_sysfs_ids, server->s_sysfs_id);
1039
1040	ida_destroy(&server->lockowner_id);
1041	ida_destroy(&server->openowner_id);
1042	put_cred(server->cred);
 
 
1043	nfs_release_automount_timer();
1044	call_rcu(&server->rcu, delayed_free);
1045}
1046EXPORT_SYMBOL_GPL(nfs_free_server);
1047
1048/*
1049 * Create a version 2 or 3 volume record
1050 * - keyed on server and FSID
1051 */
1052struct nfs_server *nfs_create_server(struct fs_context *fc)
 
1053{
1054	struct nfs_fs_context *ctx = nfs_fc2context(fc);
1055	struct nfs_server *server;
1056	struct nfs_fattr *fattr;
1057	int error;
1058
1059	server = nfs_alloc_server();
1060	if (!server)
1061		return ERR_PTR(-ENOMEM);
1062
1063	server->cred = get_cred(fc->cred);
1064
1065	error = -ENOMEM;
1066	fattr = nfs_alloc_fattr();
1067	if (fattr == NULL)
1068		goto error;
1069
1070	/* Get a client representation */
1071	error = nfs_init_server(server, fc);
1072	if (error < 0)
1073		goto error;
1074
1075	/* Probe the root fh to retrieve its FSID */
1076	error = nfs_probe_fsinfo(server, ctx->mntfh, fattr);
1077	if (error < 0)
1078		goto error;
1079	if (server->nfs_client->rpc_ops->version == 3) {
1080		if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1081			server->namelen = NFS3_MAXNAMLEN;
1082		if (!(ctx->flags & NFS_MOUNT_NORDIRPLUS))
1083			server->caps |= NFS_CAP_READDIRPLUS;
1084	} else {
1085		if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1086			server->namelen = NFS2_MAXNAMLEN;
1087	}
1088
1089	if (!(fattr->valid & NFS_ATTR_FATTR)) {
1090		error = ctx->nfs_mod->rpc_ops->getattr(server, ctx->mntfh,
1091						       fattr, NULL);
1092		if (error < 0) {
1093			dprintk("nfs_create_server: getattr error = %d\n", -error);
1094			goto error;
1095		}
1096	}
1097	memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1098
1099	dprintk("Server FSID: %llx:%llx\n",
1100		(unsigned long long) server->fsid.major,
1101		(unsigned long long) server->fsid.minor);
1102
1103	nfs_server_insert_lists(server);
1104	server->mount_time = jiffies;
1105	nfs_free_fattr(fattr);
1106	return server;
1107
1108error:
1109	nfs_free_fattr(fattr);
1110	nfs_free_server(server);
1111	return ERR_PTR(error);
1112}
1113EXPORT_SYMBOL_GPL(nfs_create_server);
1114
1115/*
1116 * Clone an NFS2, NFS3 or NFS4 server record
1117 */
1118struct nfs_server *nfs_clone_server(struct nfs_server *source,
1119				    struct nfs_fh *fh,
1120				    struct nfs_fattr *fattr,
1121				    rpc_authflavor_t flavor)
1122{
1123	struct nfs_server *server;
 
1124	int error;
1125
 
 
 
 
1126	server = nfs_alloc_server();
1127	if (!server)
1128		return ERR_PTR(-ENOMEM);
1129
1130	server->cred = get_cred(source->cred);
 
 
 
1131
1132	/* Copy data from the source */
1133	server->nfs_client = source->nfs_client;
1134	server->destroy = source->destroy;
1135	refcount_inc(&server->nfs_client->cl_count);
1136	nfs_server_copy_userdata(server, source);
1137
1138	server->fsid = fattr->fsid;
1139
1140	nfs_sysfs_add_server(server);
1141
1142	nfs_sysfs_link_rpc_client(server,
1143		server->nfs_client->cl_rpcclient, "_state");
1144
1145	error = nfs_init_server_rpcclient(server,
1146			source->client->cl_timeout,
1147			flavor);
1148	if (error < 0)
1149		goto out_free_server;
1150
1151	/* probe the filesystem info for this server filesystem */
1152	error = nfs_probe_server(server, fh);
1153	if (error < 0)
1154		goto out_free_server;
1155
1156	if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1157		server->namelen = NFS4_MAXNAMLEN;
1158
 
 
 
 
1159	error = nfs_start_lockd(server);
1160	if (error < 0)
1161		goto out_free_server;
1162
1163	nfs_server_insert_lists(server);
1164	server->mount_time = jiffies;
1165
 
 
1166	return server;
1167
1168out_free_server:
 
1169	nfs_free_server(server);
 
1170	return ERR_PTR(error);
1171}
1172EXPORT_SYMBOL_GPL(nfs_clone_server);
1173
1174void nfs_clients_init(struct net *net)
1175{
1176	struct nfs_net *nn = net_generic(net, nfs_net_id);
1177
1178	INIT_LIST_HEAD(&nn->nfs_client_list);
1179	INIT_LIST_HEAD(&nn->nfs_volume_list);
1180#if IS_ENABLED(CONFIG_NFS_V4)
1181	idr_init(&nn->cb_ident_idr);
1182#endif
1183	spin_lock_init(&nn->nfs_client_lock);
1184	nn->boot_time = ktime_get_real();
1185
1186	nfs_netns_sysfs_setup(nn, net);
1187}
1188
1189void nfs_clients_exit(struct net *net)
1190{
1191	struct nfs_net *nn = net_generic(net, nfs_net_id);
1192
1193	nfs_netns_sysfs_destroy(nn);
1194	nfs_cleanup_cb_ident_idr(net);
1195	WARN_ON_ONCE(!list_empty(&nn->nfs_client_list));
1196	WARN_ON_ONCE(!list_empty(&nn->nfs_volume_list));
1197}
1198
1199#ifdef CONFIG_PROC_FS
 
1200static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1201static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1202static void nfs_server_list_stop(struct seq_file *p, void *v);
1203static int nfs_server_list_show(struct seq_file *m, void *v);
1204
1205static const struct seq_operations nfs_server_list_ops = {
1206	.start	= nfs_server_list_start,
1207	.next	= nfs_server_list_next,
1208	.stop	= nfs_server_list_stop,
1209	.show	= nfs_server_list_show,
1210};
1211
 
 
 
 
 
 
 
 
1212static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1213static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1214static void nfs_volume_list_stop(struct seq_file *p, void *v);
1215static int nfs_volume_list_show(struct seq_file *m, void *v);
1216
1217static const struct seq_operations nfs_volume_list_ops = {
1218	.start	= nfs_volume_list_start,
1219	.next	= nfs_volume_list_next,
1220	.stop	= nfs_volume_list_stop,
1221	.show	= nfs_volume_list_show,
1222};
1223
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1224/*
1225 * set up the iterator to start reading from the server list and return the first item
1226 */
1227static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1228				__acquires(&nn->nfs_client_lock)
1229{
1230	struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1231
1232	/* lock the list against modification */
1233	spin_lock(&nn->nfs_client_lock);
1234	return seq_list_start_head(&nn->nfs_client_list, *_pos);
1235}
1236
1237/*
1238 * move to next server
1239 */
1240static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1241{
1242	struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1243
1244	return seq_list_next(v, &nn->nfs_client_list, pos);
1245}
1246
1247/*
1248 * clean up after reading from the transports list
1249 */
1250static void nfs_server_list_stop(struct seq_file *p, void *v)
1251				__releases(&nn->nfs_client_lock)
1252{
1253	struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1254
1255	spin_unlock(&nn->nfs_client_lock);
1256}
1257
1258/*
1259 * display a header line followed by a load of call lines
1260 */
1261static int nfs_server_list_show(struct seq_file *m, void *v)
1262{
1263	struct nfs_client *clp;
1264	struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1265
1266	/* display header on line 1 */
1267	if (v == &nn->nfs_client_list) {
1268		seq_puts(m, "NV SERVER   PORT USE HOSTNAME\n");
1269		return 0;
1270	}
1271
1272	/* display one transport per line on subsequent lines */
1273	clp = list_entry(v, struct nfs_client, cl_share_link);
1274
1275	/* Check if the client is initialized */
1276	if (clp->cl_cons_state != NFS_CS_READY)
1277		return 0;
1278
1279	rcu_read_lock();
1280	seq_printf(m, "v%u %s %s %3d %s\n",
1281		   clp->rpc_ops->version,
1282		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1283		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1284		   refcount_read(&clp->cl_count),
1285		   clp->cl_hostname);
1286	rcu_read_unlock();
1287
1288	return 0;
1289}
1290
1291/*
 
 
 
 
 
 
 
 
 
1292 * set up the iterator to start reading from the volume list and return the first item
1293 */
1294static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1295				__acquires(&nn->nfs_client_lock)
1296{
1297	struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1298
1299	/* lock the list against modification */
1300	spin_lock(&nn->nfs_client_lock);
1301	return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1302}
1303
1304/*
1305 * move to next volume
1306 */
1307static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1308{
1309	struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1310
1311	return seq_list_next(v, &nn->nfs_volume_list, pos);
1312}
1313
1314/*
1315 * clean up after reading from the transports list
1316 */
1317static void nfs_volume_list_stop(struct seq_file *p, void *v)
1318				__releases(&nn->nfs_client_lock)
1319{
1320	struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1321
1322	spin_unlock(&nn->nfs_client_lock);
1323}
1324
1325/*
1326 * display a header line followed by a load of call lines
1327 */
1328static int nfs_volume_list_show(struct seq_file *m, void *v)
1329{
1330	struct nfs_server *server;
1331	struct nfs_client *clp;
1332	char dev[13];	// 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1333	char fsid[34];	// 2 * 16 for %llx, 1 for ':', 1 for '\0'
1334	struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1335
1336	/* display header on line 1 */
1337	if (v == &nn->nfs_volume_list) {
1338		seq_puts(m, "NV SERVER   PORT DEV          FSID"
1339			    "                              FSC\n");
1340		return 0;
1341	}
1342	/* display one transport per line on subsequent lines */
1343	server = list_entry(v, struct nfs_server, master_link);
1344	clp = server->nfs_client;
1345
1346	snprintf(dev, sizeof(dev), "%u:%u",
1347		 MAJOR(server->s_dev), MINOR(server->s_dev));
1348
1349	snprintf(fsid, sizeof(fsid), "%llx:%llx",
1350		 (unsigned long long) server->fsid.major,
1351		 (unsigned long long) server->fsid.minor);
1352
1353	rcu_read_lock();
1354	seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1355		   clp->rpc_ops->version,
1356		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1357		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1358		   dev,
1359		   fsid,
1360		   nfs_server_fscache_state(server));
1361	rcu_read_unlock();
1362
1363	return 0;
1364}
1365
1366int nfs_fs_proc_net_init(struct net *net)
1367{
1368	struct nfs_net *nn = net_generic(net, nfs_net_id);
1369	struct proc_dir_entry *p;
1370
1371	nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1372	if (!nn->proc_nfsfs)
1373		goto error_0;
1374
1375	/* a file of servers with which we're dealing */
1376	p = proc_create_net("servers", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1377			&nfs_server_list_ops, sizeof(struct seq_net_private));
1378	if (!p)
1379		goto error_1;
1380
1381	/* a file of volumes that we have mounted */
1382	p = proc_create_net("volumes", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1383			&nfs_volume_list_ops, sizeof(struct seq_net_private));
1384	if (!p)
1385		goto error_1;
1386	return 0;
1387
1388error_1:
1389	remove_proc_subtree("nfsfs", net->proc_net);
1390error_0:
1391	return -ENOMEM;
1392}
1393
1394void nfs_fs_proc_net_exit(struct net *net)
1395{
1396	remove_proc_subtree("nfsfs", net->proc_net);
1397}
1398
1399/*
1400 * initialise the /proc/fs/nfsfs/ directory
1401 */
1402int __init nfs_fs_proc_init(void)
1403{
1404	if (!proc_mkdir("fs/nfsfs", NULL))
1405		goto error_0;
1406
1407	/* a file of servers with which we're dealing */
1408	if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1409		goto error_1;
1410
1411	/* a file of volumes that we have mounted */
1412	if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1413		goto error_1;
1414
1415	return 0;
1416error_1:
1417	remove_proc_subtree("fs/nfsfs", NULL);
1418error_0:
1419	return -ENOMEM;
1420}
1421
1422/*
1423 * clean up the /proc/fs/nfsfs/ directory
1424 */
1425void nfs_fs_proc_exit(void)
1426{
1427	remove_proc_subtree("fs/nfsfs", NULL);
1428	ida_destroy(&s_sysfs_ids);
1429}
1430
1431#endif /* CONFIG_PROC_FS */
v4.10.11
 
   1/* client.c: NFS client sharing and management code
   2 *
   3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
   4 * Written by David Howells (dhowells@redhat.com)
   5 *
   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.
  10 */
  11
  12
  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>
  18#include <linux/mm.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>
  40#include <net/ipv6.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>
  45
  46
  47#include "nfs4_fs.h"
  48#include "callback.h"
  49#include "delegation.h"
  50#include "iostat.h"
  51#include "internal.h"
  52#include "fscache.h"
  53#include "pnfs.h"
  54#include "nfs.h"
  55#include "netns.h"
 
 
  56
  57#define NFSDBG_FACILITY		NFSDBG_CLIENT
  58
  59static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
  60static DEFINE_SPINLOCK(nfs_version_lock);
  61static DEFINE_MUTEX(nfs_version_mutex);
  62static LIST_HEAD(nfs_versions);
  63
  64/*
  65 * RPC cruft for NFS
  66 */
  67static const struct rpc_version *nfs_version[5] = {
  68	[2] = NULL,
  69	[3] = NULL,
  70	[4] = NULL,
  71};
  72
  73const struct rpc_program nfs_program = {
  74	.name			= "nfs",
  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,
  80};
  81
  82struct rpc_stat nfs_rpcstat = {
  83	.program		= &nfs_program
  84};
  85
  86static struct nfs_subversion *find_nfs_version(unsigned int version)
  87{
  88	struct nfs_subversion *nfs;
  89	spin_lock(&nfs_version_lock);
  90
  91	list_for_each_entry(nfs, &nfs_versions, list) {
  92		if (nfs->rpc_ops->version == version) {
  93			spin_unlock(&nfs_version_lock);
  94			return nfs;
  95		}
  96	}
  97
  98	spin_unlock(&nfs_version_lock);
  99	return ERR_PTR(-EPROTONOSUPPORT);
 100}
 101
 102struct nfs_subversion *get_nfs_version(unsigned int version)
 103{
 104	struct nfs_subversion *nfs = find_nfs_version(version);
 105
 106	if (IS_ERR(nfs)) {
 107		mutex_lock(&nfs_version_mutex);
 108		request_module("nfsv%d", version);
 109		nfs = find_nfs_version(version);
 110		mutex_unlock(&nfs_version_mutex);
 111	}
 112
 113	if (!IS_ERR(nfs) && !try_module_get(nfs->owner))
 114		return ERR_PTR(-EAGAIN);
 115	return nfs;
 116}
 117
 118void put_nfs_version(struct nfs_subversion *nfs)
 119{
 120	module_put(nfs->owner);
 121}
 122
 123void register_nfs_version(struct nfs_subversion *nfs)
 124{
 125	spin_lock(&nfs_version_lock);
 126
 127	list_add(&nfs->list, &nfs_versions);
 128	nfs_version[nfs->rpc_ops->version] = nfs->rpc_vers;
 129
 130	spin_unlock(&nfs_version_lock);
 131}
 132EXPORT_SYMBOL_GPL(register_nfs_version);
 133
 134void unregister_nfs_version(struct nfs_subversion *nfs)
 135{
 136	spin_lock(&nfs_version_lock);
 137
 138	nfs_version[nfs->rpc_ops->version] = NULL;
 139	list_del(&nfs->list);
 140
 141	spin_unlock(&nfs_version_lock);
 142}
 143EXPORT_SYMBOL_GPL(unregister_nfs_version);
 144
 145/*
 146 * Allocate a shared client record
 147 *
 148 * Since these are allocated/deallocated very rarely, we don't
 149 * bother putting them in a slab cache...
 150 */
 151struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
 152{
 153	struct nfs_client *clp;
 154	struct rpc_cred *cred;
 155	int err = -ENOMEM;
 156
 157	if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
 158		goto error_0;
 159
 
 160	clp->cl_nfs_mod = cl_init->nfs_mod;
 161	if (!try_module_get(clp->cl_nfs_mod->owner))
 162		goto error_dealloc;
 163
 164	clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
 165
 166	atomic_set(&clp->cl_count, 1);
 167	clp->cl_cons_state = NFS_CS_INITING;
 168
 169	memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
 170	clp->cl_addrlen = cl_init->addrlen;
 171
 172	if (cl_init->hostname) {
 173		err = -ENOMEM;
 174		clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
 175		if (!clp->cl_hostname)
 176			goto error_cleanup;
 177	}
 178
 179	INIT_LIST_HEAD(&clp->cl_superblocks);
 180	clp->cl_rpcclient = ERR_PTR(-EINVAL);
 181
 
 182	clp->cl_proto = cl_init->proto;
 
 
 183	clp->cl_net = get_net(cl_init->net);
 184
 185	cred = rpc_lookup_machine_cred("*");
 186	if (!IS_ERR(cred))
 187		clp->cl_machine_cred = cred;
 188	nfs_fscache_get_client_cookie(clp);
 189
 190	return clp;
 191
 192error_cleanup:
 193	put_nfs_version(clp->cl_nfs_mod);
 194error_dealloc:
 195	kfree(clp);
 196error_0:
 197	return ERR_PTR(err);
 198}
 199EXPORT_SYMBOL_GPL(nfs_alloc_client);
 200
 201#if IS_ENABLED(CONFIG_NFS_V4)
 202void nfs_cleanup_cb_ident_idr(struct net *net)
 203{
 204	struct nfs_net *nn = net_generic(net, nfs_net_id);
 205
 206	idr_destroy(&nn->cb_ident_idr);
 207}
 208
 209/* nfs_client_lock held */
 210static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
 211{
 212	struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
 213
 214	if (clp->cl_cb_ident)
 215		idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
 216}
 217
 218static void pnfs_init_server(struct nfs_server *server)
 219{
 220	rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
 221}
 222
 223#else
 224void nfs_cleanup_cb_ident_idr(struct net *net)
 225{
 226}
 227
 228static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
 229{
 230}
 231
 232static void pnfs_init_server(struct nfs_server *server)
 233{
 234}
 235
 236#endif /* CONFIG_NFS_V4 */
 237
 238/*
 239 * Destroy a shared client record
 240 */
 241void nfs_free_client(struct nfs_client *clp)
 242{
 243	dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
 244
 245	nfs_fscache_release_client_cookie(clp);
 246
 247	/* -EIO all pending I/O */
 248	if (!IS_ERR(clp->cl_rpcclient))
 249		rpc_shutdown_client(clp->cl_rpcclient);
 250
 251	if (clp->cl_machine_cred != NULL)
 252		put_rpccred(clp->cl_machine_cred);
 253
 254	put_net(clp->cl_net);
 255	put_nfs_version(clp->cl_nfs_mod);
 256	kfree(clp->cl_hostname);
 257	kfree(clp->cl_acceptor);
 258	kfree(clp);
 259
 260	dprintk("<-- nfs_free_client()\n");
 261}
 262EXPORT_SYMBOL_GPL(nfs_free_client);
 263
 264/*
 265 * Release a reference to a shared client record
 266 */
 267void nfs_put_client(struct nfs_client *clp)
 268{
 269	struct nfs_net *nn;
 270
 271	if (!clp)
 272		return;
 273
 274	dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
 275	nn = net_generic(clp->cl_net, nfs_net_id);
 276
 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);
 281
 282		WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
 283
 284		clp->rpc_ops->free_client(clp);
 285	}
 286}
 287EXPORT_SYMBOL_GPL(nfs_put_client);
 288
 289/*
 290 * Find an nfs_client on the list that matches the initialisation data
 291 * that is supplied.
 292 */
 293static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
 294{
 295	struct nfs_client *clp;
 296	const struct sockaddr *sap = data->addr;
 297	struct nfs_net *nn = net_generic(data->net, nfs_net_id);
 
 298
 
 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)
 303			continue;
 304
 
 
 
 
 
 
 
 
 
 
 
 
 305		/* Different NFS versions cannot share the same nfs_client */
 306		if (clp->rpc_ops != data->nfs_mod->rpc_ops)
 307			continue;
 308
 309		if (clp->cl_proto != data->proto)
 310			continue;
 311		/* Match nfsv4 minorversion */
 312		if (clp->cl_minorversion != data->minorversion)
 313			continue;
 
 
 
 
 
 
 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,
 319							   sap))
 320				continue;
 321
 322		atomic_inc(&clp->cl_count);
 
 
 
 
 323		return clp;
 324	}
 325	return NULL;
 326}
 327
 328static bool nfs_client_init_is_complete(const struct nfs_client *clp)
 
 
 
 
 
 329{
 330	return clp->cl_cons_state <= NFS_CS_READY;
 331}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 332
 333int nfs_wait_client_init_complete(const struct nfs_client *clp)
 334{
 335	return wait_event_killable(nfs_client_active_wq,
 336			nfs_client_init_is_complete(clp));
 337}
 338EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
 339
 340/*
 341 * Found an existing client.  Make sure it's ready before returning.
 342 */
 343static struct nfs_client *
 344nfs_found_client(const struct nfs_client_initdata *cl_init,
 345		 struct nfs_client *clp)
 346{
 347	int error;
 348
 349	error = nfs_wait_client_init_complete(clp);
 350	if (error < 0) {
 351		nfs_put_client(clp);
 352		return ERR_PTR(-ERESTARTSYS);
 353	}
 354
 355	if (clp->cl_cons_state < NFS_CS_READY) {
 356		error = clp->cl_cons_state;
 357		nfs_put_client(clp);
 358		return ERR_PTR(error);
 359	}
 360
 361	smp_rmb();
 362
 363	dprintk("<-- %s found nfs_client %p for %s\n",
 364		__func__, clp, cl_init->hostname ?: "");
 365	return clp;
 366}
 367
 368/*
 369 * Look up a client by IP address and protocol version
 370 * - creates a new record if one doesn't yet exist
 371 */
 372struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
 373{
 374	struct nfs_client *clp, *new = NULL;
 375	struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
 376	const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
 377
 378	if (cl_init->hostname == NULL) {
 379		WARN_ON(1);
 380		return NULL;
 381	}
 382
 383	dprintk("--> nfs_get_client(%s,v%u)\n",
 384		cl_init->hostname, rpc_ops->version);
 385
 386	/* see if the client already exists */
 387	do {
 388		spin_lock(&nn->nfs_client_lock);
 389
 390		clp = nfs_match_client(cl_init);
 391		if (clp) {
 392			spin_unlock(&nn->nfs_client_lock);
 393			if (new)
 394				new->rpc_ops->free_client(new);
 
 
 395			return nfs_found_client(cl_init, clp);
 396		}
 397		if (new) {
 398			list_add_tail(&new->cl_share_link,
 399					&nn->nfs_client_list);
 400			spin_unlock(&nn->nfs_client_lock);
 401			new->cl_flags = cl_init->init_flags;
 402			return rpc_ops->init_client(new, cl_init);
 403		}
 404
 405		spin_unlock(&nn->nfs_client_lock);
 406
 407		new = rpc_ops->alloc_client(cl_init);
 408	} while (!IS_ERR(new));
 409
 410	dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
 411		cl_init->hostname, PTR_ERR(new));
 412	return new;
 413}
 414EXPORT_SYMBOL_GPL(nfs_get_client);
 415
 416/*
 417 * Mark a server as ready or failed
 418 */
 419void nfs_mark_client_ready(struct nfs_client *clp, int state)
 420{
 421	smp_wmb();
 422	clp->cl_cons_state = state;
 423	wake_up_all(&nfs_client_active_wq);
 424}
 425EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
 426
 427/*
 428 * Initialise the timeout values for a connection
 429 */
 430void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
 431				    int timeo, int retrans)
 432{
 433	to->to_initval = timeo * HZ / 10;
 434	to->to_retries = retrans;
 435
 436	switch (proto) {
 437	case XPRT_TRANSPORT_TCP:
 
 438	case XPRT_TRANSPORT_RDMA:
 439		if (retrans == NFS_UNSPEC_RETRANS)
 440			to->to_retries = NFS_DEF_TCP_RETRANS;
 441		if (timeo == NFS_UNSPEC_TIMEO || to->to_retries == 0)
 442			to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
 443		if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
 444			to->to_initval = NFS_MAX_TCP_TIMEOUT;
 445		to->to_increment = to->to_initval;
 446		to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
 447		if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
 448			to->to_maxval = NFS_MAX_TCP_TIMEOUT;
 449		if (to->to_maxval < to->to_initval)
 450			to->to_maxval = to->to_initval;
 451		to->to_exponential = 0;
 452		break;
 453	case XPRT_TRANSPORT_UDP:
 454		if (retrans == NFS_UNSPEC_RETRANS)
 455			to->to_retries = NFS_DEF_UDP_RETRANS;
 456		if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
 457			to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
 458		if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
 459			to->to_initval = NFS_MAX_UDP_TIMEOUT;
 460		to->to_maxval = NFS_MAX_UDP_TIMEOUT;
 461		to->to_exponential = 1;
 462		break;
 463	default:
 464		BUG();
 465	}
 466}
 467EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
 468
 469/*
 470 * Create an RPC client handle
 471 */
 472int nfs_create_rpc_client(struct nfs_client *clp,
 473			  const struct nfs_client_initdata *cl_init,
 474			  rpc_authflavor_t flavor)
 475{
 476	struct rpc_clnt		*clnt = NULL;
 477	struct rpc_create_args args = {
 478		.net		= clp->cl_net,
 479		.protocol	= clp->cl_proto,
 
 480		.address	= (struct sockaddr *)&clp->cl_addr,
 481		.addrsize	= clp->cl_addrlen,
 482		.timeout	= cl_init->timeparms,
 483		.servername	= clp->cl_hostname,
 484		.nodename	= cl_init->nodename,
 485		.program	= &nfs_program,
 486		.version	= clp->rpc_ops->version,
 487		.authflavor	= flavor,
 
 
 
 
 488	};
 489
 490	if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
 491		args.flags |= RPC_CLNT_CREATE_DISCRTRY;
 492	if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
 493		args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
 494	if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
 495		args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
 496	if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
 497		args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
 
 
 
 
 498
 499	if (!IS_ERR(clp->cl_rpcclient))
 500		return 0;
 501
 502	clnt = rpc_create(&args);
 503	if (IS_ERR(clnt)) {
 504		dprintk("%s: cannot create RPC client. Error = %ld\n",
 505				__func__, PTR_ERR(clnt));
 506		return PTR_ERR(clnt);
 507	}
 508
 
 509	clp->cl_rpcclient = clnt;
 
 510	return 0;
 511}
 512EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
 513
 514/*
 515 * Version 2 or 3 client destruction
 516 */
 517static void nfs_destroy_server(struct nfs_server *server)
 518{
 519	if (server->nlm_host)
 520		nlmclnt_done(server->nlm_host);
 521}
 522
 523/*
 524 * Version 2 or 3 lockd setup
 525 */
 526static int nfs_start_lockd(struct nfs_server *server)
 527{
 528	struct nlm_host *host;
 529	struct nfs_client *clp = server->nfs_client;
 530	struct nlmclnt_initdata nlm_init = {
 531		.hostname	= clp->cl_hostname,
 532		.address	= (struct sockaddr *)&clp->cl_addr,
 533		.addrlen	= clp->cl_addrlen,
 534		.nfs_version	= clp->rpc_ops->version,
 535		.noresvport	= server->flags & NFS_MOUNT_NORESVPORT ?
 536					1 : 0,
 537		.net		= clp->cl_net,
 
 
 538	};
 539
 540	if (nlm_init.nfs_version > 3)
 541		return 0;
 542	if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
 543			(server->flags & NFS_MOUNT_LOCAL_FCNTL))
 544		return 0;
 545
 546	switch (clp->cl_proto) {
 547		default:
 548			nlm_init.protocol = IPPROTO_TCP;
 549			break;
 
 550		case XPRT_TRANSPORT_UDP:
 551			nlm_init.protocol = IPPROTO_UDP;
 
 552	}
 553
 554	host = nlmclnt_init(&nlm_init);
 555	if (IS_ERR(host))
 556		return PTR_ERR(host);
 557
 558	server->nlm_host = host;
 559	server->destroy = nfs_destroy_server;
 
 560	return 0;
 561}
 562
 563/*
 564 * Create a general RPC client
 565 */
 566int nfs_init_server_rpcclient(struct nfs_server *server,
 567		const struct rpc_timeout *timeo,
 568		rpc_authflavor_t pseudoflavour)
 569{
 570	struct nfs_client *clp = server->nfs_client;
 571
 572	server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
 573							pseudoflavour);
 574	if (IS_ERR(server->client)) {
 575		dprintk("%s: couldn't create rpc_client!\n", __func__);
 576		return PTR_ERR(server->client);
 577	}
 578
 579	memcpy(&server->client->cl_timeout_default,
 580			timeo,
 581			sizeof(server->client->cl_timeout_default));
 582	server->client->cl_timeout = &server->client->cl_timeout_default;
 583	server->client->cl_softrtry = 0;
 
 
 584	if (server->flags & NFS_MOUNT_SOFT)
 585		server->client->cl_softrtry = 1;
 586
 
 587	return 0;
 588}
 589EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
 590
 591/**
 592 * nfs_init_client - Initialise an NFS2 or NFS3 client
 593 *
 594 * @clp: nfs_client to initialise
 595 * @cl_init: Initialisation parameters
 596 *
 597 * Returns pointer to an NFS client, or an ERR_PTR value.
 598 */
 599struct nfs_client *nfs_init_client(struct nfs_client *clp,
 600				   const struct nfs_client_initdata *cl_init)
 601{
 602	int error;
 603
 604	if (clp->cl_cons_state == NFS_CS_READY) {
 605		/* the client is already initialised */
 606		dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
 607		return clp;
 608	}
 609
 610	/*
 611	 * Create a client RPC handle for doing FSSTAT with UNIX auth only
 612	 * - RFC 2623, sec 2.3.2
 613	 */
 614	error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
 615	if (error < 0)
 616		goto error;
 617	nfs_mark_client_ready(clp, NFS_CS_READY);
 
 
 618	return clp;
 619
 620error:
 621	nfs_mark_client_ready(clp, error);
 622	nfs_put_client(clp);
 623	dprintk("<-- nfs_init_client() = xerror %d\n", error);
 624	return ERR_PTR(error);
 625}
 626EXPORT_SYMBOL_GPL(nfs_init_client);
 627
 628/*
 629 * Create a version 2 or 3 client
 630 */
 631static int nfs_init_server(struct nfs_server *server,
 632			   const struct nfs_parsed_mount_data *data,
 633			   struct nfs_subversion *nfs_mod)
 634{
 
 635	struct rpc_timeout timeparms;
 636	struct nfs_client_initdata cl_init = {
 637		.hostname = data->nfs_server.hostname,
 638		.addr = (const struct sockaddr *)&data->nfs_server.address,
 639		.addrlen = data->nfs_server.addrlen,
 640		.nfs_mod = nfs_mod,
 641		.proto = data->nfs_server.protocol,
 642		.net = data->net,
 643		.timeparms = &timeparms,
 
 
 
 
 644	};
 645	struct nfs_client *clp;
 646	int error;
 647
 648	dprintk("--> nfs_init_server()\n");
 649
 650	nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
 651			data->timeo, data->retrans);
 652	if (data->flags & NFS_MOUNT_NORESVPORT)
 653		set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
 654
 655	/* Allocate or find a client reference we can use */
 656	clp = nfs_get_client(&cl_init);
 657	if (IS_ERR(clp)) {
 658		dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
 659		return PTR_ERR(clp);
 660	}
 661
 662	server->nfs_client = clp;
 
 
 663
 664	/* Initialise the client representation from the mount data */
 665	server->flags = data->flags;
 666	server->options = data->options;
 667	server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
 668		NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
 669		NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
 670
 671	if (data->rsize)
 672		server->rsize = nfs_block_size(data->rsize, NULL);
 673	if (data->wsize)
 674		server->wsize = nfs_block_size(data->wsize, NULL);
 675
 676	server->acregmin = data->acregmin * HZ;
 677	server->acregmax = data->acregmax * HZ;
 678	server->acdirmin = data->acdirmin * HZ;
 679	server->acdirmax = data->acdirmax * HZ;
 
 
 
 
 
 
 
 
 
 680
 681	/* Start lockd here, before we might error out */
 682	error = nfs_start_lockd(server);
 683	if (error < 0)
 684		goto error;
 685
 686	server->port = data->nfs_server.port;
 687	server->auth_info = data->auth_info;
 688
 689	error = nfs_init_server_rpcclient(server, &timeparms,
 690					  data->selected_flavor);
 691	if (error < 0)
 692		goto error;
 693
 694	/* Preserve the values of mount_server-related mount options */
 695	if (data->mount_server.addrlen) {
 696		memcpy(&server->mountd_address, &data->mount_server.address,
 697			data->mount_server.addrlen);
 698		server->mountd_addrlen = data->mount_server.addrlen;
 699	}
 700	server->mountd_version = data->mount_server.version;
 701	server->mountd_port = data->mount_server.port;
 702	server->mountd_protocol = data->mount_server.protocol;
 703
 704	server->namelen  = data->namlen;
 705	dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
 706	return 0;
 707
 708error:
 709	server->nfs_client = NULL;
 710	nfs_put_client(clp);
 711	dprintk("<-- nfs_init_server() = xerror %d\n", error);
 712	return error;
 713}
 714
 715/*
 716 * Load up the server record from information gained in an fsinfo record
 717 */
 718static void nfs_server_set_fsinfo(struct nfs_server *server,
 719				  struct nfs_fsinfo *fsinfo)
 720{
 721	unsigned long max_rpc_payload;
 
 722
 723	/* Work out a lot of parameters */
 724	if (server->rsize == 0)
 725		server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
 726	if (server->wsize == 0)
 727		server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
 728
 729	if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
 730		server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
 731	if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
 732		server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
 
 
 
 733
 734	max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
 735	if (server->rsize > max_rpc_payload)
 736		server->rsize = max_rpc_payload;
 737	if (server->rsize > NFS_MAX_FILE_IO_SIZE)
 738		server->rsize = NFS_MAX_FILE_IO_SIZE;
 739	server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
 740
 741	server->backing_dev_info.name = "nfs";
 742	server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
 743
 744	if (server->wsize > max_rpc_payload)
 745		server->wsize = max_rpc_payload;
 746	if (server->wsize > NFS_MAX_FILE_IO_SIZE)
 747		server->wsize = NFS_MAX_FILE_IO_SIZE;
 748	server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
 749
 750	server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
 751
 752	server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
 753	if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
 754		server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
 755	if (server->dtsize > server->rsize)
 756		server->dtsize = server->rsize;
 757
 758	if (server->flags & NFS_MOUNT_NOAC) {
 759		server->acregmin = server->acregmax = 0;
 760		server->acdirmin = server->acdirmax = 0;
 761	}
 762
 763	server->maxfilesize = fsinfo->maxfilesize;
 764
 765	server->time_delta = fsinfo->time_delta;
 
 766
 767	server->clone_blksize = fsinfo->clone_blksize;
 768	/* We're airborne Set socket buffersize */
 769	rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 770}
 771
 772/*
 773 * Probe filesystem information, including the FSID on v2/v3
 774 */
 775int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
 776{
 777	struct nfs_fsinfo fsinfo;
 778	struct nfs_client *clp = server->nfs_client;
 779	int error;
 780
 781	dprintk("--> nfs_probe_fsinfo()\n");
 782
 783	if (clp->rpc_ops->set_capabilities != NULL) {
 784		error = clp->rpc_ops->set_capabilities(server, mntfh);
 785		if (error < 0)
 786			goto out_error;
 787	}
 788
 789	fsinfo.fattr = fattr;
 790	fsinfo.nlayouttypes = 0;
 791	memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
 792	error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
 793	if (error < 0)
 794		goto out_error;
 795
 796	nfs_server_set_fsinfo(server, &fsinfo);
 797
 798	/* Get some general file system info */
 799	if (server->namelen == 0) {
 800		struct nfs_pathconf pathinfo;
 801
 802		pathinfo.fattr = fattr;
 803		nfs_fattr_init(fattr);
 804
 805		if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
 806			server->namelen = pathinfo.max_namelen;
 807	}
 808
 809	dprintk("<-- nfs_probe_fsinfo() = 0\n");
 
 
 
 
 
 
 
 810	return 0;
 
 811
 812out_error:
 813	dprintk("nfs_probe_fsinfo: error = %d\n", -error);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 814	return error;
 815}
 816EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
 817
 818/*
 819 * Copy useful information when duplicating a server record
 820 */
 821void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
 822{
 823	target->flags = source->flags;
 824	target->rsize = source->rsize;
 825	target->wsize = source->wsize;
 826	target->acregmin = source->acregmin;
 827	target->acregmax = source->acregmax;
 828	target->acdirmin = source->acdirmin;
 829	target->acdirmax = source->acdirmax;
 830	target->caps = source->caps;
 831	target->options = source->options;
 832	target->auth_info = source->auth_info;
 
 833}
 834EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
 835
 836void nfs_server_insert_lists(struct nfs_server *server)
 837{
 838	struct nfs_client *clp = server->nfs_client;
 839	struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
 840
 841	spin_lock(&nn->nfs_client_lock);
 842	list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
 843	list_add_tail(&server->master_link, &nn->nfs_volume_list);
 844	clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
 845	spin_unlock(&nn->nfs_client_lock);
 846
 847}
 848EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
 849
 850void nfs_server_remove_lists(struct nfs_server *server)
 851{
 852	struct nfs_client *clp = server->nfs_client;
 853	struct nfs_net *nn;
 854
 855	if (clp == NULL)
 856		return;
 857	nn = net_generic(clp->cl_net, nfs_net_id);
 858	spin_lock(&nn->nfs_client_lock);
 859	list_del_rcu(&server->client_link);
 860	if (list_empty(&clp->cl_superblocks))
 861		set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
 862	list_del(&server->master_link);
 863	spin_unlock(&nn->nfs_client_lock);
 864
 865	synchronize_rcu();
 866}
 867EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
 868
 
 
 869/*
 870 * Allocate and initialise a server record
 871 */
 872struct nfs_server *nfs_alloc_server(void)
 873{
 874	struct nfs_server *server;
 875
 876	server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
 877	if (!server)
 878		return NULL;
 879
 
 
 
 
 
 
 880	server->client = server->client_acl = ERR_PTR(-EINVAL);
 881
 882	/* Zero out the NFS state stuff */
 883	INIT_LIST_HEAD(&server->client_link);
 884	INIT_LIST_HEAD(&server->master_link);
 885	INIT_LIST_HEAD(&server->delegations);
 886	INIT_LIST_HEAD(&server->layouts);
 887	INIT_LIST_HEAD(&server->state_owners_lru);
 
 888
 889	atomic_set(&server->active, 0);
 890
 891	server->io_stats = nfs_alloc_iostats();
 892	if (!server->io_stats) {
 893		kfree(server);
 894		return NULL;
 895	}
 896
 897	if (bdi_init(&server->backing_dev_info)) {
 898		nfs_free_iostats(server->io_stats);
 899		kfree(server);
 900		return NULL;
 901	}
 902
 903	ida_init(&server->openowner_id);
 904	ida_init(&server->lockowner_id);
 905	pnfs_init_server(server);
 
 906
 907	return server;
 908}
 909EXPORT_SYMBOL_GPL(nfs_alloc_server);
 910
 
 
 
 
 
 
 
 
 911/*
 912 * Free up a server record
 913 */
 914void nfs_free_server(struct nfs_server *server)
 915{
 916	dprintk("--> nfs_free_server()\n");
 917
 918	nfs_server_remove_lists(server);
 919
 920	if (server->destroy != NULL)
 921		server->destroy(server);
 922
 923	if (!IS_ERR(server->client_acl))
 924		rpc_shutdown_client(server->client_acl);
 925	if (!IS_ERR(server->client))
 926		rpc_shutdown_client(server->client);
 927
 928	nfs_put_client(server->nfs_client);
 929
 
 
 
 
 
 
 930	ida_destroy(&server->lockowner_id);
 931	ida_destroy(&server->openowner_id);
 932	nfs_free_iostats(server->io_stats);
 933	bdi_destroy(&server->backing_dev_info);
 934	kfree(server);
 935	nfs_release_automount_timer();
 936	dprintk("<-- nfs_free_server()\n");
 937}
 938EXPORT_SYMBOL_GPL(nfs_free_server);
 939
 940/*
 941 * Create a version 2 or 3 volume record
 942 * - keyed on server and FSID
 943 */
 944struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
 945				     struct nfs_subversion *nfs_mod)
 946{
 
 947	struct nfs_server *server;
 948	struct nfs_fattr *fattr;
 949	int error;
 950
 951	server = nfs_alloc_server();
 952	if (!server)
 953		return ERR_PTR(-ENOMEM);
 954
 
 
 955	error = -ENOMEM;
 956	fattr = nfs_alloc_fattr();
 957	if (fattr == NULL)
 958		goto error;
 959
 960	/* Get a client representation */
 961	error = nfs_init_server(server, mount_info->parsed, nfs_mod);
 962	if (error < 0)
 963		goto error;
 964
 965	/* Probe the root fh to retrieve its FSID */
 966	error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
 967	if (error < 0)
 968		goto error;
 969	if (server->nfs_client->rpc_ops->version == 3) {
 970		if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
 971			server->namelen = NFS3_MAXNAMLEN;
 972		if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
 973			server->caps |= NFS_CAP_READDIRPLUS;
 974	} else {
 975		if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
 976			server->namelen = NFS2_MAXNAMLEN;
 977	}
 978
 979	if (!(fattr->valid & NFS_ATTR_FATTR)) {
 980		error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr, NULL);
 
 981		if (error < 0) {
 982			dprintk("nfs_create_server: getattr error = %d\n", -error);
 983			goto error;
 984		}
 985	}
 986	memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
 987
 988	dprintk("Server FSID: %llx:%llx\n",
 989		(unsigned long long) server->fsid.major,
 990		(unsigned long long) server->fsid.minor);
 991
 992	nfs_server_insert_lists(server);
 993	server->mount_time = jiffies;
 994	nfs_free_fattr(fattr);
 995	return server;
 996
 997error:
 998	nfs_free_fattr(fattr);
 999	nfs_free_server(server);
1000	return ERR_PTR(error);
1001}
1002EXPORT_SYMBOL_GPL(nfs_create_server);
1003
1004/*
1005 * Clone an NFS2, NFS3 or NFS4 server record
1006 */
1007struct nfs_server *nfs_clone_server(struct nfs_server *source,
1008				    struct nfs_fh *fh,
1009				    struct nfs_fattr *fattr,
1010				    rpc_authflavor_t flavor)
1011{
1012	struct nfs_server *server;
1013	struct nfs_fattr *fattr_fsinfo;
1014	int error;
1015
1016	dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1017		(unsigned long long) fattr->fsid.major,
1018		(unsigned long long) fattr->fsid.minor);
1019
1020	server = nfs_alloc_server();
1021	if (!server)
1022		return ERR_PTR(-ENOMEM);
1023
1024	error = -ENOMEM;
1025	fattr_fsinfo = nfs_alloc_fattr();
1026	if (fattr_fsinfo == NULL)
1027		goto out_free_server;
1028
1029	/* Copy data from the source */
1030	server->nfs_client = source->nfs_client;
1031	server->destroy = source->destroy;
1032	atomic_inc(&server->nfs_client->cl_count);
1033	nfs_server_copy_userdata(server, source);
1034
1035	server->fsid = fattr->fsid;
1036
 
 
 
 
 
1037	error = nfs_init_server_rpcclient(server,
1038			source->client->cl_timeout,
1039			flavor);
1040	if (error < 0)
1041		goto out_free_server;
1042
1043	/* probe the filesystem info for this server filesystem */
1044	error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1045	if (error < 0)
1046		goto out_free_server;
1047
1048	if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1049		server->namelen = NFS4_MAXNAMLEN;
1050
1051	dprintk("Cloned FSID: %llx:%llx\n",
1052		(unsigned long long) server->fsid.major,
1053		(unsigned long long) server->fsid.minor);
1054
1055	error = nfs_start_lockd(server);
1056	if (error < 0)
1057		goto out_free_server;
1058
1059	nfs_server_insert_lists(server);
1060	server->mount_time = jiffies;
1061
1062	nfs_free_fattr(fattr_fsinfo);
1063	dprintk("<-- nfs_clone_server() = %p\n", server);
1064	return server;
1065
1066out_free_server:
1067	nfs_free_fattr(fattr_fsinfo);
1068	nfs_free_server(server);
1069	dprintk("<-- nfs_clone_server() = error %d\n", error);
1070	return ERR_PTR(error);
1071}
1072EXPORT_SYMBOL_GPL(nfs_clone_server);
1073
1074void nfs_clients_init(struct net *net)
1075{
1076	struct nfs_net *nn = net_generic(net, nfs_net_id);
1077
1078	INIT_LIST_HEAD(&nn->nfs_client_list);
1079	INIT_LIST_HEAD(&nn->nfs_volume_list);
1080#if IS_ENABLED(CONFIG_NFS_V4)
1081	idr_init(&nn->cb_ident_idr);
1082#endif
1083	spin_lock_init(&nn->nfs_client_lock);
1084	nn->boot_time = ktime_get_real();
 
 
 
 
 
 
 
 
 
 
 
 
1085}
1086
1087#ifdef CONFIG_PROC_FS
1088static int nfs_server_list_open(struct inode *inode, struct file *file);
1089static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1090static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1091static void nfs_server_list_stop(struct seq_file *p, void *v);
1092static int nfs_server_list_show(struct seq_file *m, void *v);
1093
1094static const struct seq_operations nfs_server_list_ops = {
1095	.start	= nfs_server_list_start,
1096	.next	= nfs_server_list_next,
1097	.stop	= nfs_server_list_stop,
1098	.show	= nfs_server_list_show,
1099};
1100
1101static const struct file_operations nfs_server_list_fops = {
1102	.open		= nfs_server_list_open,
1103	.read		= seq_read,
1104	.llseek		= seq_lseek,
1105	.release	= seq_release_net,
1106};
1107
1108static int nfs_volume_list_open(struct inode *inode, struct file *file);
1109static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1110static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1111static void nfs_volume_list_stop(struct seq_file *p, void *v);
1112static int nfs_volume_list_show(struct seq_file *m, void *v);
1113
1114static const struct seq_operations nfs_volume_list_ops = {
1115	.start	= nfs_volume_list_start,
1116	.next	= nfs_volume_list_next,
1117	.stop	= nfs_volume_list_stop,
1118	.show	= nfs_volume_list_show,
1119};
1120
1121static const struct file_operations nfs_volume_list_fops = {
1122	.open		= nfs_volume_list_open,
1123	.read		= seq_read,
1124	.llseek		= seq_lseek,
1125	.release	= seq_release_net,
1126};
1127
1128/*
1129 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1130 * we're dealing
1131 */
1132static int nfs_server_list_open(struct inode *inode, struct file *file)
1133{
1134	return seq_open_net(inode, file, &nfs_server_list_ops,
1135			   sizeof(struct seq_net_private));
1136}
1137
1138/*
1139 * set up the iterator to start reading from the server list and return the first item
1140 */
1141static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1142				__acquires(&nn->nfs_client_lock)
1143{
1144	struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1145
1146	/* lock the list against modification */
1147	spin_lock(&nn->nfs_client_lock);
1148	return seq_list_start_head(&nn->nfs_client_list, *_pos);
1149}
1150
1151/*
1152 * move to next server
1153 */
1154static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1155{
1156	struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1157
1158	return seq_list_next(v, &nn->nfs_client_list, pos);
1159}
1160
1161/*
1162 * clean up after reading from the transports list
1163 */
1164static void nfs_server_list_stop(struct seq_file *p, void *v)
1165				__releases(&nn->nfs_client_lock)
1166{
1167	struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1168
1169	spin_unlock(&nn->nfs_client_lock);
1170}
1171
1172/*
1173 * display a header line followed by a load of call lines
1174 */
1175static int nfs_server_list_show(struct seq_file *m, void *v)
1176{
1177	struct nfs_client *clp;
1178	struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1179
1180	/* display header on line 1 */
1181	if (v == &nn->nfs_client_list) {
1182		seq_puts(m, "NV SERVER   PORT USE HOSTNAME\n");
1183		return 0;
1184	}
1185
1186	/* display one transport per line on subsequent lines */
1187	clp = list_entry(v, struct nfs_client, cl_share_link);
1188
1189	/* Check if the client is initialized */
1190	if (clp->cl_cons_state != NFS_CS_READY)
1191		return 0;
1192
1193	rcu_read_lock();
1194	seq_printf(m, "v%u %s %s %3d %s\n",
1195		   clp->rpc_ops->version,
1196		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1197		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1198		   atomic_read(&clp->cl_count),
1199		   clp->cl_hostname);
1200	rcu_read_unlock();
1201
1202	return 0;
1203}
1204
1205/*
1206 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1207 */
1208static int nfs_volume_list_open(struct inode *inode, struct file *file)
1209{
1210	return seq_open_net(inode, file, &nfs_volume_list_ops,
1211			   sizeof(struct seq_net_private));
1212}
1213
1214/*
1215 * set up the iterator to start reading from the volume list and return the first item
1216 */
1217static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1218				__acquires(&nn->nfs_client_lock)
1219{
1220	struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1221
1222	/* lock the list against modification */
1223	spin_lock(&nn->nfs_client_lock);
1224	return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1225}
1226
1227/*
1228 * move to next volume
1229 */
1230static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1231{
1232	struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1233
1234	return seq_list_next(v, &nn->nfs_volume_list, pos);
1235}
1236
1237/*
1238 * clean up after reading from the transports list
1239 */
1240static void nfs_volume_list_stop(struct seq_file *p, void *v)
1241				__releases(&nn->nfs_client_lock)
1242{
1243	struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1244
1245	spin_unlock(&nn->nfs_client_lock);
1246}
1247
1248/*
1249 * display a header line followed by a load of call lines
1250 */
1251static int nfs_volume_list_show(struct seq_file *m, void *v)
1252{
1253	struct nfs_server *server;
1254	struct nfs_client *clp;
1255	char dev[13];	// 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1256	char fsid[34];	// 2 * 16 for %llx, 1 for ':', 1 for '\0'
1257	struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1258
1259	/* display header on line 1 */
1260	if (v == &nn->nfs_volume_list) {
1261		seq_puts(m, "NV SERVER   PORT DEV          FSID"
1262			    "                              FSC\n");
1263		return 0;
1264	}
1265	/* display one transport per line on subsequent lines */
1266	server = list_entry(v, struct nfs_server, master_link);
1267	clp = server->nfs_client;
1268
1269	snprintf(dev, sizeof(dev), "%u:%u",
1270		 MAJOR(server->s_dev), MINOR(server->s_dev));
1271
1272	snprintf(fsid, sizeof(fsid), "%llx:%llx",
1273		 (unsigned long long) server->fsid.major,
1274		 (unsigned long long) server->fsid.minor);
1275
1276	rcu_read_lock();
1277	seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1278		   clp->rpc_ops->version,
1279		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1280		   rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1281		   dev,
1282		   fsid,
1283		   nfs_server_fscache_state(server));
1284	rcu_read_unlock();
1285
1286	return 0;
1287}
1288
1289int nfs_fs_proc_net_init(struct net *net)
1290{
1291	struct nfs_net *nn = net_generic(net, nfs_net_id);
1292	struct proc_dir_entry *p;
1293
1294	nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1295	if (!nn->proc_nfsfs)
1296		goto error_0;
1297
1298	/* a file of servers with which we're dealing */
1299	p = proc_create("servers", S_IFREG|S_IRUGO,
1300			nn->proc_nfsfs, &nfs_server_list_fops);
1301	if (!p)
1302		goto error_1;
1303
1304	/* a file of volumes that we have mounted */
1305	p = proc_create("volumes", S_IFREG|S_IRUGO,
1306			nn->proc_nfsfs, &nfs_volume_list_fops);
1307	if (!p)
1308		goto error_1;
1309	return 0;
1310
1311error_1:
1312	remove_proc_subtree("nfsfs", net->proc_net);
1313error_0:
1314	return -ENOMEM;
1315}
1316
1317void nfs_fs_proc_net_exit(struct net *net)
1318{
1319	remove_proc_subtree("nfsfs", net->proc_net);
1320}
1321
1322/*
1323 * initialise the /proc/fs/nfsfs/ directory
1324 */
1325int __init nfs_fs_proc_init(void)
1326{
1327	if (!proc_mkdir("fs/nfsfs", NULL))
1328		goto error_0;
1329
1330	/* a file of servers with which we're dealing */
1331	if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1332		goto error_1;
1333
1334	/* a file of volumes that we have mounted */
1335	if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1336		goto error_1;
1337
1338	return 0;
1339error_1:
1340	remove_proc_subtree("fs/nfsfs", NULL);
1341error_0:
1342	return -ENOMEM;
1343}
1344
1345/*
1346 * clean up the /proc/fs/nfsfs/ directory
1347 */
1348void nfs_fs_proc_exit(void)
1349{
1350	remove_proc_subtree("fs/nfsfs", NULL);
 
1351}
1352
1353#endif /* CONFIG_PROC_FS */