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