Linux Audio

Check our new training course

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