blob: 0a2b59c1ecb3d066bbdf8b35bf8cea2676a56bfb [file] [log] [blame]
xjb04a4022021-11-25 15:01:52 +08001/* 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 refcount_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 nfs_fscache_release_client_cookie(clp);
244
245 /* -EIO all pending I/O */
246 if (!IS_ERR(clp->cl_rpcclient))
247 rpc_shutdown_client(clp->cl_rpcclient);
248
249 if (clp->cl_machine_cred != NULL)
250 put_rpccred(clp->cl_machine_cred);
251
252 put_net(clp->cl_net);
253 put_nfs_version(clp->cl_nfs_mod);
254 kfree(clp->cl_hostname);
255 kfree(clp->cl_acceptor);
256 kfree(clp);
257}
258EXPORT_SYMBOL_GPL(nfs_free_client);
259
260/*
261 * Release a reference to a shared client record
262 */
263void nfs_put_client(struct nfs_client *clp)
264{
265 struct nfs_net *nn;
266
267 if (!clp)
268 return;
269
270 nn = net_generic(clp->cl_net, nfs_net_id);
271
272 if (refcount_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
273 list_del(&clp->cl_share_link);
274 nfs_cb_idr_remove_locked(clp);
275 spin_unlock(&nn->nfs_client_lock);
276
277 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
278
279 clp->rpc_ops->free_client(clp);
280 }
281}
282EXPORT_SYMBOL_GPL(nfs_put_client);
283
284/*
285 * Find an nfs_client on the list that matches the initialisation data
286 * that is supplied.
287 */
288static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
289{
290 struct nfs_client *clp;
291 const struct sockaddr *sap = data->addr;
292 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
293 int error;
294
295again:
296 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
297 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
298 /* Don't match clients that failed to initialise properly */
299 if (clp->cl_cons_state < 0)
300 continue;
301
302 /* If a client is still initializing then we need to wait */
303 if (clp->cl_cons_state > NFS_CS_READY) {
304 refcount_inc(&clp->cl_count);
305 spin_unlock(&nn->nfs_client_lock);
306 error = nfs_wait_client_init_complete(clp);
307 nfs_put_client(clp);
308 spin_lock(&nn->nfs_client_lock);
309 if (error < 0)
310 return ERR_PTR(error);
311 goto again;
312 }
313
314 /* Different NFS versions cannot share the same nfs_client */
315 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
316 continue;
317
318 if (clp->cl_proto != data->proto)
319 continue;
320 /* Match nfsv4 minorversion */
321 if (clp->cl_minorversion != data->minorversion)
322 continue;
323 /* Match the full socket address */
324 if (!rpc_cmp_addr_port(sap, clap))
325 /* Match all xprt_switch full socket addresses */
326 if (IS_ERR(clp->cl_rpcclient) ||
327 !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
328 sap))
329 continue;
330
331 refcount_inc(&clp->cl_count);
332 return clp;
333 }
334 return NULL;
335}
336
337/*
338 * Return true if @clp is done initializing, false if still working on it.
339 *
340 * Use nfs_client_init_status to check if it was successful.
341 */
342bool nfs_client_init_is_complete(const struct nfs_client *clp)
343{
344 return clp->cl_cons_state <= NFS_CS_READY;
345}
346EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
347
348/*
349 * Return 0 if @clp was successfully initialized, -errno otherwise.
350 *
351 * This must be called *after* nfs_client_init_is_complete() returns true,
352 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
353 */
354int nfs_client_init_status(const struct nfs_client *clp)
355{
356 /* called without checking nfs_client_init_is_complete */
357 if (clp->cl_cons_state > NFS_CS_READY) {
358 WARN_ON_ONCE(1);
359 return -EINVAL;
360 }
361 return clp->cl_cons_state;
362}
363EXPORT_SYMBOL_GPL(nfs_client_init_status);
364
365int nfs_wait_client_init_complete(const struct nfs_client *clp)
366{
367 return wait_event_killable(nfs_client_active_wq,
368 nfs_client_init_is_complete(clp));
369}
370EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
371
372/*
373 * Found an existing client. Make sure it's ready before returning.
374 */
375static struct nfs_client *
376nfs_found_client(const struct nfs_client_initdata *cl_init,
377 struct nfs_client *clp)
378{
379 int error;
380
381 error = nfs_wait_client_init_complete(clp);
382 if (error < 0) {
383 nfs_put_client(clp);
384 return ERR_PTR(-ERESTARTSYS);
385 }
386
387 if (clp->cl_cons_state < NFS_CS_READY) {
388 error = clp->cl_cons_state;
389 nfs_put_client(clp);
390 return ERR_PTR(error);
391 }
392
393 smp_rmb();
394 return clp;
395}
396
397/*
398 * Look up a client by IP address and protocol version
399 * - creates a new record if one doesn't yet exist
400 */
401struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
402{
403 struct nfs_client *clp, *new = NULL;
404 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
405 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
406
407 if (cl_init->hostname == NULL) {
408 WARN_ON(1);
409 return NULL;
410 }
411
412 /* see if the client already exists */
413 do {
414 spin_lock(&nn->nfs_client_lock);
415
416 clp = nfs_match_client(cl_init);
417 if (clp) {
418 spin_unlock(&nn->nfs_client_lock);
419 if (new)
420 new->rpc_ops->free_client(new);
421 if (IS_ERR(clp))
422 return clp;
423 return nfs_found_client(cl_init, clp);
424 }
425 if (new) {
426 list_add_tail(&new->cl_share_link,
427 &nn->nfs_client_list);
428 spin_unlock(&nn->nfs_client_lock);
429 new->cl_flags = cl_init->init_flags;
430 return rpc_ops->init_client(new, cl_init);
431 }
432
433 spin_unlock(&nn->nfs_client_lock);
434
435 new = rpc_ops->alloc_client(cl_init);
436 } while (!IS_ERR(new));
437
438 return new;
439}
440EXPORT_SYMBOL_GPL(nfs_get_client);
441
442/*
443 * Mark a server as ready or failed
444 */
445void nfs_mark_client_ready(struct nfs_client *clp, int state)
446{
447 smp_wmb();
448 clp->cl_cons_state = state;
449 wake_up_all(&nfs_client_active_wq);
450}
451EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
452
453/*
454 * Initialise the timeout values for a connection
455 */
456void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
457 int timeo, int retrans)
458{
459 to->to_initval = timeo * HZ / 10;
460 to->to_retries = retrans;
461
462 switch (proto) {
463 case XPRT_TRANSPORT_TCP:
464 case XPRT_TRANSPORT_RDMA:
465 if (retrans == NFS_UNSPEC_RETRANS)
466 to->to_retries = NFS_DEF_TCP_RETRANS;
467 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
468 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
469 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
470 to->to_initval = NFS_MAX_TCP_TIMEOUT;
471 to->to_increment = to->to_initval;
472 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
473 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
474 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
475 if (to->to_maxval < to->to_initval)
476 to->to_maxval = to->to_initval;
477 to->to_exponential = 0;
478 break;
479 case XPRT_TRANSPORT_UDP:
480 if (retrans == NFS_UNSPEC_RETRANS)
481 to->to_retries = NFS_DEF_UDP_RETRANS;
482 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
483 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
484 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
485 to->to_initval = NFS_MAX_UDP_TIMEOUT;
486 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
487 to->to_exponential = 1;
488 break;
489 default:
490 BUG();
491 }
492}
493EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
494
495/*
496 * Create an RPC client handle
497 */
498int nfs_create_rpc_client(struct nfs_client *clp,
499 const struct nfs_client_initdata *cl_init,
500 rpc_authflavor_t flavor)
501{
502 struct rpc_clnt *clnt = NULL;
503 struct rpc_create_args args = {
504 .net = clp->cl_net,
505 .protocol = clp->cl_proto,
506 .address = (struct sockaddr *)&clp->cl_addr,
507 .addrsize = clp->cl_addrlen,
508 .timeout = cl_init->timeparms,
509 .servername = clp->cl_hostname,
510 .nodename = cl_init->nodename,
511 .program = &nfs_program,
512 .version = clp->rpc_ops->version,
513 .authflavor = flavor,
514 };
515
516 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
517 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
518 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
519 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
520 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
521 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
522 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
523 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
524
525 if (!IS_ERR(clp->cl_rpcclient))
526 return 0;
527
528 clnt = rpc_create(&args);
529 if (IS_ERR(clnt)) {
530 dprintk("%s: cannot create RPC client. Error = %ld\n",
531 __func__, PTR_ERR(clnt));
532 return PTR_ERR(clnt);
533 }
534
535 clp->cl_rpcclient = clnt;
536 return 0;
537}
538EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
539
540/*
541 * Version 2 or 3 client destruction
542 */
543static void nfs_destroy_server(struct nfs_server *server)
544{
545 if (server->nlm_host)
546 nlmclnt_done(server->nlm_host);
547}
548
549/*
550 * Version 2 or 3 lockd setup
551 */
552static int nfs_start_lockd(struct nfs_server *server)
553{
554 struct nlm_host *host;
555 struct nfs_client *clp = server->nfs_client;
556 struct nlmclnt_initdata nlm_init = {
557 .hostname = clp->cl_hostname,
558 .address = (struct sockaddr *)&clp->cl_addr,
559 .addrlen = clp->cl_addrlen,
560 .nfs_version = clp->rpc_ops->version,
561 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
562 1 : 0,
563 .net = clp->cl_net,
564 .nlmclnt_ops = clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
565 };
566
567 if (nlm_init.nfs_version > 3)
568 return 0;
569 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
570 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
571 return 0;
572
573 switch (clp->cl_proto) {
574 default:
575 nlm_init.protocol = IPPROTO_TCP;
576 break;
577 case XPRT_TRANSPORT_UDP:
578 nlm_init.protocol = IPPROTO_UDP;
579 }
580
581 host = nlmclnt_init(&nlm_init);
582 if (IS_ERR(host))
583 return PTR_ERR(host);
584
585 server->nlm_host = host;
586 server->destroy = nfs_destroy_server;
587 return 0;
588}
589
590/*
591 * Create a general RPC client
592 */
593int nfs_init_server_rpcclient(struct nfs_server *server,
594 const struct rpc_timeout *timeo,
595 rpc_authflavor_t pseudoflavour)
596{
597 struct nfs_client *clp = server->nfs_client;
598
599 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
600 pseudoflavour);
601 if (IS_ERR(server->client)) {
602 dprintk("%s: couldn't create rpc_client!\n", __func__);
603 return PTR_ERR(server->client);
604 }
605
606 memcpy(&server->client->cl_timeout_default,
607 timeo,
608 sizeof(server->client->cl_timeout_default));
609 server->client->cl_timeout = &server->client->cl_timeout_default;
610 server->client->cl_softrtry = 0;
611 if (server->flags & NFS_MOUNT_SOFT)
612 server->client->cl_softrtry = 1;
613
614 return 0;
615}
616EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
617
618/**
619 * nfs_init_client - Initialise an NFS2 or NFS3 client
620 *
621 * @clp: nfs_client to initialise
622 * @cl_init: Initialisation parameters
623 *
624 * Returns pointer to an NFS client, or an ERR_PTR value.
625 */
626struct nfs_client *nfs_init_client(struct nfs_client *clp,
627 const struct nfs_client_initdata *cl_init)
628{
629 int error;
630
631 /* the client is already initialised */
632 if (clp->cl_cons_state == NFS_CS_READY)
633 return clp;
634
635 /*
636 * Create a client RPC handle for doing FSSTAT with UNIX auth only
637 * - RFC 2623, sec 2.3.2
638 */
639 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
640 nfs_mark_client_ready(clp, error == 0 ? NFS_CS_READY : error);
641 if (error < 0) {
642 nfs_put_client(clp);
643 clp = ERR_PTR(error);
644 }
645 return clp;
646}
647EXPORT_SYMBOL_GPL(nfs_init_client);
648
649/*
650 * Create a version 2 or 3 client
651 */
652static int nfs_init_server(struct nfs_server *server,
653 const struct nfs_parsed_mount_data *data,
654 struct nfs_subversion *nfs_mod)
655{
656 struct rpc_timeout timeparms;
657 struct nfs_client_initdata cl_init = {
658 .hostname = data->nfs_server.hostname,
659 .addr = (const struct sockaddr *)&data->nfs_server.address,
660 .addrlen = data->nfs_server.addrlen,
661 .nfs_mod = nfs_mod,
662 .proto = data->nfs_server.protocol,
663 .net = data->net,
664 .timeparms = &timeparms,
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 kfree(server);
934 nfs_release_automount_timer();
935}
936EXPORT_SYMBOL_GPL(nfs_free_server);
937
938/*
939 * Create a version 2 or 3 volume record
940 * - keyed on server and FSID
941 */
942struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
943 struct nfs_subversion *nfs_mod)
944{
945 struct nfs_server *server;
946 struct nfs_fattr *fattr;
947 int error;
948
949 server = nfs_alloc_server();
950 if (!server)
951 return ERR_PTR(-ENOMEM);
952
953 error = -ENOMEM;
954 fattr = nfs_alloc_fattr();
955 if (fattr == NULL)
956 goto error;
957
958 /* Get a client representation */
959 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
960 if (error < 0)
961 goto error;
962
963 /* Probe the root fh to retrieve its FSID */
964 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
965 if (error < 0)
966 goto error;
967 if (server->nfs_client->rpc_ops->version == 3) {
968 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
969 server->namelen = NFS3_MAXNAMLEN;
970 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
971 server->caps |= NFS_CAP_READDIRPLUS;
972 } else {
973 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
974 server->namelen = NFS2_MAXNAMLEN;
975 }
976
977 if (!(fattr->valid & NFS_ATTR_FATTR)) {
978 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh,
979 fattr, NULL, NULL);
980 if (error < 0) {
981 dprintk("nfs_create_server: getattr error = %d\n", -error);
982 goto error;
983 }
984 }
985 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
986
987 dprintk("Server FSID: %llx:%llx\n",
988 (unsigned long long) server->fsid.major,
989 (unsigned long long) server->fsid.minor);
990
991 nfs_server_insert_lists(server);
992 server->mount_time = jiffies;
993 nfs_free_fattr(fattr);
994 return server;
995
996error:
997 nfs_free_fattr(fattr);
998 nfs_free_server(server);
999 return ERR_PTR(error);
1000}
1001EXPORT_SYMBOL_GPL(nfs_create_server);
1002
1003/*
1004 * Clone an NFS2, NFS3 or NFS4 server record
1005 */
1006struct nfs_server *nfs_clone_server(struct nfs_server *source,
1007 struct nfs_fh *fh,
1008 struct nfs_fattr *fattr,
1009 rpc_authflavor_t flavor)
1010{
1011 struct nfs_server *server;
1012 struct nfs_fattr *fattr_fsinfo;
1013 int error;
1014
1015 server = nfs_alloc_server();
1016 if (!server)
1017 return ERR_PTR(-ENOMEM);
1018
1019 error = -ENOMEM;
1020 fattr_fsinfo = nfs_alloc_fattr();
1021 if (fattr_fsinfo == NULL)
1022 goto out_free_server;
1023
1024 /* Copy data from the source */
1025 server->nfs_client = source->nfs_client;
1026 server->destroy = source->destroy;
1027 refcount_inc(&server->nfs_client->cl_count);
1028 nfs_server_copy_userdata(server, source);
1029
1030 server->fsid = fattr->fsid;
1031
1032 error = nfs_init_server_rpcclient(server,
1033 source->client->cl_timeout,
1034 flavor);
1035 if (error < 0)
1036 goto out_free_server;
1037
1038 /* probe the filesystem info for this server filesystem */
1039 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1040 if (error < 0)
1041 goto out_free_server;
1042
1043 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1044 server->namelen = NFS4_MAXNAMLEN;
1045
1046 error = nfs_start_lockd(server);
1047 if (error < 0)
1048 goto out_free_server;
1049
1050 nfs_server_insert_lists(server);
1051 server->mount_time = jiffies;
1052
1053 nfs_free_fattr(fattr_fsinfo);
1054 return server;
1055
1056out_free_server:
1057 nfs_free_fattr(fattr_fsinfo);
1058 nfs_free_server(server);
1059 return ERR_PTR(error);
1060}
1061EXPORT_SYMBOL_GPL(nfs_clone_server);
1062
1063void nfs_clients_init(struct net *net)
1064{
1065 struct nfs_net *nn = net_generic(net, nfs_net_id);
1066
1067 INIT_LIST_HEAD(&nn->nfs_client_list);
1068 INIT_LIST_HEAD(&nn->nfs_volume_list);
1069#if IS_ENABLED(CONFIG_NFS_V4)
1070 idr_init(&nn->cb_ident_idr);
1071#endif
1072 spin_lock_init(&nn->nfs_client_lock);
1073 nn->boot_time = ktime_get_real();
1074}
1075
1076#ifdef CONFIG_PROC_FS
1077static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1078static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1079static void nfs_server_list_stop(struct seq_file *p, void *v);
1080static int nfs_server_list_show(struct seq_file *m, void *v);
1081
1082static const struct seq_operations nfs_server_list_ops = {
1083 .start = nfs_server_list_start,
1084 .next = nfs_server_list_next,
1085 .stop = nfs_server_list_stop,
1086 .show = nfs_server_list_show,
1087};
1088
1089static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1090static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1091static void nfs_volume_list_stop(struct seq_file *p, void *v);
1092static int nfs_volume_list_show(struct seq_file *m, void *v);
1093
1094static const struct seq_operations nfs_volume_list_ops = {
1095 .start = nfs_volume_list_start,
1096 .next = nfs_volume_list_next,
1097 .stop = nfs_volume_list_stop,
1098 .show = nfs_volume_list_show,
1099};
1100
1101/*
1102 * set up the iterator to start reading from the server list and return the first item
1103 */
1104static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1105 __acquires(&nn->nfs_client_lock)
1106{
1107 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1108
1109 /* lock the list against modification */
1110 spin_lock(&nn->nfs_client_lock);
1111 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1112}
1113
1114/*
1115 * move to next server
1116 */
1117static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1118{
1119 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1120
1121 return seq_list_next(v, &nn->nfs_client_list, pos);
1122}
1123
1124/*
1125 * clean up after reading from the transports list
1126 */
1127static void nfs_server_list_stop(struct seq_file *p, void *v)
1128 __releases(&nn->nfs_client_lock)
1129{
1130 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1131
1132 spin_unlock(&nn->nfs_client_lock);
1133}
1134
1135/*
1136 * display a header line followed by a load of call lines
1137 */
1138static int nfs_server_list_show(struct seq_file *m, void *v)
1139{
1140 struct nfs_client *clp;
1141 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1142
1143 /* display header on line 1 */
1144 if (v == &nn->nfs_client_list) {
1145 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1146 return 0;
1147 }
1148
1149 /* display one transport per line on subsequent lines */
1150 clp = list_entry(v, struct nfs_client, cl_share_link);
1151
1152 /* Check if the client is initialized */
1153 if (clp->cl_cons_state != NFS_CS_READY)
1154 return 0;
1155
1156 rcu_read_lock();
1157 seq_printf(m, "v%u %s %s %3d %s\n",
1158 clp->rpc_ops->version,
1159 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1160 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1161 refcount_read(&clp->cl_count),
1162 clp->cl_hostname);
1163 rcu_read_unlock();
1164
1165 return 0;
1166}
1167
1168/*
1169 * set up the iterator to start reading from the volume list and return the first item
1170 */
1171static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1172 __acquires(&nn->nfs_client_lock)
1173{
1174 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1175
1176 /* lock the list against modification */
1177 spin_lock(&nn->nfs_client_lock);
1178 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1179}
1180
1181/*
1182 * move to next volume
1183 */
1184static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1185{
1186 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1187
1188 return seq_list_next(v, &nn->nfs_volume_list, pos);
1189}
1190
1191/*
1192 * clean up after reading from the transports list
1193 */
1194static void nfs_volume_list_stop(struct seq_file *p, void *v)
1195 __releases(&nn->nfs_client_lock)
1196{
1197 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1198
1199 spin_unlock(&nn->nfs_client_lock);
1200}
1201
1202/*
1203 * display a header line followed by a load of call lines
1204 */
1205static int nfs_volume_list_show(struct seq_file *m, void *v)
1206{
1207 struct nfs_server *server;
1208 struct nfs_client *clp;
1209 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1210 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1211 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1212
1213 /* display header on line 1 */
1214 if (v == &nn->nfs_volume_list) {
1215 seq_puts(m, "NV SERVER PORT DEV FSID"
1216 " FSC\n");
1217 return 0;
1218 }
1219 /* display one transport per line on subsequent lines */
1220 server = list_entry(v, struct nfs_server, master_link);
1221 clp = server->nfs_client;
1222
1223 snprintf(dev, sizeof(dev), "%u:%u",
1224 MAJOR(server->s_dev), MINOR(server->s_dev));
1225
1226 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1227 (unsigned long long) server->fsid.major,
1228 (unsigned long long) server->fsid.minor);
1229
1230 rcu_read_lock();
1231 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1232 clp->rpc_ops->version,
1233 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1234 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1235 dev,
1236 fsid,
1237 nfs_server_fscache_state(server));
1238 rcu_read_unlock();
1239
1240 return 0;
1241}
1242
1243int nfs_fs_proc_net_init(struct net *net)
1244{
1245 struct nfs_net *nn = net_generic(net, nfs_net_id);
1246 struct proc_dir_entry *p;
1247
1248 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1249 if (!nn->proc_nfsfs)
1250 goto error_0;
1251
1252 /* a file of servers with which we're dealing */
1253 p = proc_create_net("servers", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1254 &nfs_server_list_ops, sizeof(struct seq_net_private));
1255 if (!p)
1256 goto error_1;
1257
1258 /* a file of volumes that we have mounted */
1259 p = proc_create_net("volumes", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1260 &nfs_volume_list_ops, sizeof(struct seq_net_private));
1261 if (!p)
1262 goto error_1;
1263 return 0;
1264
1265error_1:
1266 remove_proc_subtree("nfsfs", net->proc_net);
1267error_0:
1268 return -ENOMEM;
1269}
1270
1271void nfs_fs_proc_net_exit(struct net *net)
1272{
1273 remove_proc_subtree("nfsfs", net->proc_net);
1274}
1275
1276/*
1277 * initialise the /proc/fs/nfsfs/ directory
1278 */
1279int __init nfs_fs_proc_init(void)
1280{
1281 if (!proc_mkdir("fs/nfsfs", NULL))
1282 goto error_0;
1283
1284 /* a file of servers with which we're dealing */
1285 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1286 goto error_1;
1287
1288 /* a file of volumes that we have mounted */
1289 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1290 goto error_1;
1291
1292 return 0;
1293error_1:
1294 remove_proc_subtree("fs/nfsfs", NULL);
1295error_0:
1296 return -ENOMEM;
1297}
1298
1299/*
1300 * clean up the /proc/fs/nfsfs/ directory
1301 */
1302void nfs_fs_proc_exit(void)
1303{
1304 remove_proc_subtree("fs/nfsfs", NULL);
1305}
1306
1307#endif /* CONFIG_PROC_FS */