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