GNU Linux-libre 4.19.211-gnu1
[releases.git] / fs / nfs / client.c
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
59 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
60 static DEFINE_SPINLOCK(nfs_version_lock);
61 static DEFINE_MUTEX(nfs_version_mutex);
62 static LIST_HEAD(nfs_versions);
63
64 /*
65  * RPC cruft for NFS
66  */
67 static const struct rpc_version *nfs_version[5] = {
68         [2] = NULL,
69         [3] = NULL,
70         [4] = NULL,
71 };
72
73 const 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
82 struct rpc_stat nfs_rpcstat = {
83         .program                = &nfs_program
84 };
85
86 static 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
102 struct 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
118 void put_nfs_version(struct nfs_subversion *nfs)
119 {
120         module_put(nfs->owner);
121 }
122
123 void 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 }
132 EXPORT_SYMBOL_GPL(register_nfs_version);
133
134 void 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 }
143 EXPORT_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  */
151 struct 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_minorversion = cl_init->minorversion;
161         clp->cl_nfs_mod = cl_init->nfs_mod;
162         if (!try_module_get(clp->cl_nfs_mod->owner))
163                 goto error_dealloc;
164
165         clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
166
167         refcount_set(&clp->cl_count, 1);
168         clp->cl_cons_state = NFS_CS_INITING;
169
170         memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
171         clp->cl_addrlen = cl_init->addrlen;
172
173         if (cl_init->hostname) {
174                 err = -ENOMEM;
175                 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
176                 if (!clp->cl_hostname)
177                         goto error_cleanup;
178         }
179
180         INIT_LIST_HEAD(&clp->cl_superblocks);
181         clp->cl_rpcclient = ERR_PTR(-EINVAL);
182
183         clp->cl_proto = cl_init->proto;
184         clp->cl_net = get_net(cl_init->net);
185
186         cred = rpc_lookup_machine_cred("*");
187         if (!IS_ERR(cred))
188                 clp->cl_machine_cred = cred;
189         nfs_fscache_get_client_cookie(clp);
190
191         return clp;
192
193 error_cleanup:
194         put_nfs_version(clp->cl_nfs_mod);
195 error_dealloc:
196         kfree(clp);
197 error_0:
198         return ERR_PTR(err);
199 }
200 EXPORT_SYMBOL_GPL(nfs_alloc_client);
201
202 #if IS_ENABLED(CONFIG_NFS_V4)
203 void nfs_cleanup_cb_ident_idr(struct net *net)
204 {
205         struct nfs_net *nn = net_generic(net, nfs_net_id);
206
207         idr_destroy(&nn->cb_ident_idr);
208 }
209
210 /* nfs_client_lock held */
211 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
212 {
213         struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
214
215         if (clp->cl_cb_ident)
216                 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
217 }
218
219 static void pnfs_init_server(struct nfs_server *server)
220 {
221         rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
222 }
223
224 #else
225 void nfs_cleanup_cb_ident_idr(struct net *net)
226 {
227 }
228
229 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
230 {
231 }
232
233 static void pnfs_init_server(struct nfs_server *server)
234 {
235 }
236
237 #endif /* CONFIG_NFS_V4 */
238
239 /*
240  * Destroy a shared client record
241  */
242 void nfs_free_client(struct nfs_client *clp)
243 {
244         nfs_fscache_release_client_cookie(clp);
245
246         /* -EIO all pending I/O */
247         if (!IS_ERR(clp->cl_rpcclient))
248                 rpc_shutdown_client(clp->cl_rpcclient);
249
250         if (clp->cl_machine_cred != NULL)
251                 put_rpccred(clp->cl_machine_cred);
252
253         put_net(clp->cl_net);
254         put_nfs_version(clp->cl_nfs_mod);
255         kfree(clp->cl_hostname);
256         kfree(clp->cl_acceptor);
257         kfree(clp);
258 }
259 EXPORT_SYMBOL_GPL(nfs_free_client);
260
261 /*
262  * Release a reference to a shared client record
263  */
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  */
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 = 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                 /* Match the full socket address */
325                 if (!rpc_cmp_addr_port(sap, clap))
326                         /* Match all xprt_switch full socket addresses */
327                         if (IS_ERR(clp->cl_rpcclient) ||
328                             !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
329                                                            sap))
330                                 continue;
331
332                 refcount_inc(&clp->cl_count);
333                 return clp;
334         }
335         return NULL;
336 }
337
338 /*
339  * Return true if @clp is done initializing, false if still working on it.
340  *
341  * Use nfs_client_init_status to check if it was successful.
342  */
343 bool nfs_client_init_is_complete(const struct nfs_client *clp)
344 {
345         return clp->cl_cons_state <= NFS_CS_READY;
346 }
347 EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
348
349 /*
350  * Return 0 if @clp was successfully initialized, -errno otherwise.
351  *
352  * This must be called *after* nfs_client_init_is_complete() returns true,
353  * otherwise it will pop WARN_ON_ONCE and return -EINVAL
354  */
355 int nfs_client_init_status(const struct nfs_client *clp)
356 {
357         /* called without checking nfs_client_init_is_complete */
358         if (clp->cl_cons_state > NFS_CS_READY) {
359                 WARN_ON_ONCE(1);
360                 return -EINVAL;
361         }
362         return clp->cl_cons_state;
363 }
364 EXPORT_SYMBOL_GPL(nfs_client_init_status);
365
366 int nfs_wait_client_init_complete(const struct nfs_client *clp)
367 {
368         return wait_event_killable(nfs_client_active_wq,
369                         nfs_client_init_is_complete(clp));
370 }
371 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
372
373 /*
374  * Found an existing client.  Make sure it's ready before returning.
375  */
376 static struct nfs_client *
377 nfs_found_client(const struct nfs_client_initdata *cl_init,
378                  struct nfs_client *clp)
379 {
380         int error;
381
382         error = nfs_wait_client_init_complete(clp);
383         if (error < 0) {
384                 nfs_put_client(clp);
385                 return ERR_PTR(-ERESTARTSYS);
386         }
387
388         if (clp->cl_cons_state < NFS_CS_READY) {
389                 error = clp->cl_cons_state;
390                 nfs_put_client(clp);
391                 return ERR_PTR(error);
392         }
393
394         smp_rmb();
395         return clp;
396 }
397
398 /*
399  * Look up a client by IP address and protocol version
400  * - creates a new record if one doesn't yet exist
401  */
402 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
403 {
404         struct nfs_client *clp, *new = NULL;
405         struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
406         const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
407
408         if (cl_init->hostname == NULL) {
409                 WARN_ON(1);
410                 return ERR_PTR(-EINVAL);
411         }
412
413         /* see if the client already exists */
414         do {
415                 spin_lock(&nn->nfs_client_lock);
416
417                 clp = nfs_match_client(cl_init);
418                 if (clp) {
419                         spin_unlock(&nn->nfs_client_lock);
420                         if (new)
421                                 new->rpc_ops->free_client(new);
422                         if (IS_ERR(clp))
423                                 return clp;
424                         return nfs_found_client(cl_init, clp);
425                 }
426                 if (new) {
427                         list_add_tail(&new->cl_share_link,
428                                         &nn->nfs_client_list);
429                         spin_unlock(&nn->nfs_client_lock);
430                         new->cl_flags = cl_init->init_flags;
431                         return rpc_ops->init_client(new, cl_init);
432                 }
433
434                 spin_unlock(&nn->nfs_client_lock);
435
436                 new = rpc_ops->alloc_client(cl_init);
437         } while (!IS_ERR(new));
438
439         return new;
440 }
441 EXPORT_SYMBOL_GPL(nfs_get_client);
442
443 /*
444  * Mark a server as ready or failed
445  */
446 void nfs_mark_client_ready(struct nfs_client *clp, int state)
447 {
448         smp_wmb();
449         clp->cl_cons_state = state;
450         wake_up_all(&nfs_client_active_wq);
451 }
452 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
453
454 /*
455  * Initialise the timeout values for a connection
456  */
457 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
458                                     int timeo, int retrans)
459 {
460         to->to_initval = timeo * HZ / 10;
461         to->to_retries = retrans;
462
463         switch (proto) {
464         case XPRT_TRANSPORT_TCP:
465         case XPRT_TRANSPORT_RDMA:
466                 if (retrans == NFS_UNSPEC_RETRANS)
467                         to->to_retries = NFS_DEF_TCP_RETRANS;
468                 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
469                         to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
470                 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
471                         to->to_initval = NFS_MAX_TCP_TIMEOUT;
472                 to->to_increment = to->to_initval;
473                 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
474                 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
475                         to->to_maxval = NFS_MAX_TCP_TIMEOUT;
476                 if (to->to_maxval < to->to_initval)
477                         to->to_maxval = to->to_initval;
478                 to->to_exponential = 0;
479                 break;
480         case XPRT_TRANSPORT_UDP:
481                 if (retrans == NFS_UNSPEC_RETRANS)
482                         to->to_retries = NFS_DEF_UDP_RETRANS;
483                 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
484                         to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
485                 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
486                         to->to_initval = NFS_MAX_UDP_TIMEOUT;
487                 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
488                 to->to_exponential = 1;
489                 break;
490         default:
491                 BUG();
492         }
493 }
494 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
495
496 /*
497  * Create an RPC client handle
498  */
499 int nfs_create_rpc_client(struct nfs_client *clp,
500                           const struct nfs_client_initdata *cl_init,
501                           rpc_authflavor_t flavor)
502 {
503         struct rpc_clnt         *clnt = NULL;
504         struct rpc_create_args args = {
505                 .net            = clp->cl_net,
506                 .protocol       = clp->cl_proto,
507                 .address        = (struct sockaddr *)&clp->cl_addr,
508                 .addrsize       = clp->cl_addrlen,
509                 .timeout        = cl_init->timeparms,
510                 .servername     = clp->cl_hostname,
511                 .nodename       = cl_init->nodename,
512                 .program        = &nfs_program,
513                 .version        = clp->rpc_ops->version,
514                 .authflavor     = flavor,
515         };
516
517         if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
518                 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
519         if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
520                 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
521         if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
522                 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
523         if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
524                 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
525
526         if (!IS_ERR(clp->cl_rpcclient))
527                 return 0;
528
529         clnt = rpc_create(&args);
530         if (IS_ERR(clnt)) {
531                 dprintk("%s: cannot create RPC client. Error = %ld\n",
532                                 __func__, PTR_ERR(clnt));
533                 return PTR_ERR(clnt);
534         }
535
536         clp->cl_rpcclient = clnt;
537         return 0;
538 }
539 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
540
541 /*
542  * Version 2 or 3 client destruction
543  */
544 static void nfs_destroy_server(struct nfs_server *server)
545 {
546         if (server->nlm_host)
547                 nlmclnt_done(server->nlm_host);
548 }
549
550 /*
551  * Version 2 or 3 lockd setup
552  */
553 static int nfs_start_lockd(struct nfs_server *server)
554 {
555         struct nlm_host *host;
556         struct nfs_client *clp = server->nfs_client;
557         struct nlmclnt_initdata nlm_init = {
558                 .hostname       = clp->cl_hostname,
559                 .address        = (struct sockaddr *)&clp->cl_addr,
560                 .addrlen        = clp->cl_addrlen,
561                 .nfs_version    = clp->rpc_ops->version,
562                 .noresvport     = server->flags & NFS_MOUNT_NORESVPORT ?
563                                         1 : 0,
564                 .net            = clp->cl_net,
565                 .nlmclnt_ops    = clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
566         };
567
568         if (nlm_init.nfs_version > 3)
569                 return 0;
570         if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
571                         (server->flags & NFS_MOUNT_LOCAL_FCNTL))
572                 return 0;
573
574         switch (clp->cl_proto) {
575                 default:
576                         nlm_init.protocol = IPPROTO_TCP;
577                         break;
578                 case XPRT_TRANSPORT_UDP:
579                         nlm_init.protocol = IPPROTO_UDP;
580         }
581
582         host = nlmclnt_init(&nlm_init);
583         if (IS_ERR(host))
584                 return PTR_ERR(host);
585
586         server->nlm_host = host;
587         server->destroy = nfs_destroy_server;
588         return 0;
589 }
590
591 /*
592  * Create a general RPC client
593  */
594 int nfs_init_server_rpcclient(struct nfs_server *server,
595                 const struct rpc_timeout *timeo,
596                 rpc_authflavor_t pseudoflavour)
597 {
598         struct nfs_client *clp = server->nfs_client;
599
600         server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
601                                                         pseudoflavour);
602         if (IS_ERR(server->client)) {
603                 dprintk("%s: couldn't create rpc_client!\n", __func__);
604                 return PTR_ERR(server->client);
605         }
606
607         memcpy(&server->client->cl_timeout_default,
608                         timeo,
609                         sizeof(server->client->cl_timeout_default));
610         server->client->cl_timeout = &server->client->cl_timeout_default;
611         server->client->cl_softrtry = 0;
612         if (server->flags & NFS_MOUNT_SOFT)
613                 server->client->cl_softrtry = 1;
614
615         return 0;
616 }
617 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
618
619 /**
620  * nfs_init_client - Initialise an NFS2 or NFS3 client
621  *
622  * @clp: nfs_client to initialise
623  * @cl_init: Initialisation parameters
624  *
625  * Returns pointer to an NFS client, or an ERR_PTR value.
626  */
627 struct nfs_client *nfs_init_client(struct nfs_client *clp,
628                                    const struct nfs_client_initdata *cl_init)
629 {
630         int error;
631
632         /* the client is already initialised */
633         if (clp->cl_cons_state == NFS_CS_READY)
634                 return clp;
635
636         /*
637          * Create a client RPC handle for doing FSSTAT with UNIX auth only
638          * - RFC 2623, sec 2.3.2
639          */
640         error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
641         nfs_mark_client_ready(clp, error == 0 ? NFS_CS_READY : error);
642         if (error < 0) {
643                 nfs_put_client(clp);
644                 clp = ERR_PTR(error);
645         }
646         return clp;
647 }
648 EXPORT_SYMBOL_GPL(nfs_init_client);
649
650 /*
651  * Create a version 2 or 3 client
652  */
653 static int nfs_init_server(struct nfs_server *server,
654                            const struct nfs_parsed_mount_data *data,
655                            struct nfs_subversion *nfs_mod)
656 {
657         struct rpc_timeout timeparms;
658         struct nfs_client_initdata cl_init = {
659                 .hostname = data->nfs_server.hostname,
660                 .addr = (const struct sockaddr *)&data->nfs_server.address,
661                 .addrlen = data->nfs_server.addrlen,
662                 .nfs_mod = nfs_mod,
663                 .proto = data->nfs_server.protocol,
664                 .net = data->net,
665                 .timeparms = &timeparms,
666         };
667         struct nfs_client *clp;
668         int error;
669
670         nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
671                         data->timeo, data->retrans);
672         if (data->flags & NFS_MOUNT_NORESVPORT)
673                 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
674
675         /* Allocate or find a client reference we can use */
676         clp = nfs_get_client(&cl_init);
677         if (IS_ERR(clp))
678                 return PTR_ERR(clp);
679
680         server->nfs_client = clp;
681
682         /* Initialise the client representation from the mount data */
683         server->flags = data->flags;
684         server->options = data->options;
685         server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
686                 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
687                 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
688
689         if (data->rsize)
690                 server->rsize = nfs_block_size(data->rsize, NULL);
691         if (data->wsize)
692                 server->wsize = nfs_block_size(data->wsize, NULL);
693
694         server->acregmin = data->acregmin * HZ;
695         server->acregmax = data->acregmax * HZ;
696         server->acdirmin = data->acdirmin * HZ;
697         server->acdirmax = data->acdirmax * HZ;
698
699         /* Start lockd here, before we might error out */
700         error = nfs_start_lockd(server);
701         if (error < 0)
702                 goto error;
703
704         server->port = data->nfs_server.port;
705         server->auth_info = data->auth_info;
706
707         error = nfs_init_server_rpcclient(server, &timeparms,
708                                           data->selected_flavor);
709         if (error < 0)
710                 goto error;
711
712         /* Preserve the values of mount_server-related mount options */
713         if (data->mount_server.addrlen) {
714                 memcpy(&server->mountd_address, &data->mount_server.address,
715                         data->mount_server.addrlen);
716                 server->mountd_addrlen = data->mount_server.addrlen;
717         }
718         server->mountd_version = data->mount_server.version;
719         server->mountd_port = data->mount_server.port;
720         server->mountd_protocol = data->mount_server.protocol;
721
722         server->namelen  = data->namlen;
723         return 0;
724
725 error:
726         server->nfs_client = NULL;
727         nfs_put_client(clp);
728         return error;
729 }
730
731 /*
732  * Load up the server record from information gained in an fsinfo record
733  */
734 static void nfs_server_set_fsinfo(struct nfs_server *server,
735                                   struct nfs_fsinfo *fsinfo)
736 {
737         unsigned long max_rpc_payload;
738
739         /* Work out a lot of parameters */
740         if (server->rsize == 0)
741                 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
742         if (server->wsize == 0)
743                 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
744
745         if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
746                 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
747         if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
748                 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
749
750         max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
751         if (server->rsize > max_rpc_payload)
752                 server->rsize = max_rpc_payload;
753         if (server->rsize > NFS_MAX_FILE_IO_SIZE)
754                 server->rsize = NFS_MAX_FILE_IO_SIZE;
755         server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
756
757         if (server->wsize > max_rpc_payload)
758                 server->wsize = max_rpc_payload;
759         if (server->wsize > NFS_MAX_FILE_IO_SIZE)
760                 server->wsize = NFS_MAX_FILE_IO_SIZE;
761         server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
762
763         server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
764
765         server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
766         if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
767                 server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
768         if (server->dtsize > server->rsize)
769                 server->dtsize = server->rsize;
770
771         if (server->flags & NFS_MOUNT_NOAC) {
772                 server->acregmin = server->acregmax = 0;
773                 server->acdirmin = server->acdirmax = 0;
774         }
775
776         server->maxfilesize = fsinfo->maxfilesize;
777
778         server->time_delta = fsinfo->time_delta;
779
780         server->clone_blksize = fsinfo->clone_blksize;
781         /* We're airborne Set socket buffersize */
782         rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
783 }
784
785 /*
786  * Probe filesystem information, including the FSID on v2/v3
787  */
788 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
789 {
790         struct nfs_fsinfo fsinfo;
791         struct nfs_client *clp = server->nfs_client;
792         int error;
793
794         if (clp->rpc_ops->set_capabilities != NULL) {
795                 error = clp->rpc_ops->set_capabilities(server, mntfh);
796                 if (error < 0)
797                         return error;
798         }
799
800         fsinfo.fattr = fattr;
801         fsinfo.nlayouttypes = 0;
802         memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
803         error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
804         if (error < 0)
805                 return error;
806
807         nfs_server_set_fsinfo(server, &fsinfo);
808
809         /* Get some general file system info */
810         if (server->namelen == 0) {
811                 struct nfs_pathconf pathinfo;
812
813                 pathinfo.fattr = fattr;
814                 nfs_fattr_init(fattr);
815
816                 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
817                         server->namelen = pathinfo.max_namelen;
818         }
819
820         return 0;
821 }
822 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
823
824 /*
825  * Copy useful information when duplicating a server record
826  */
827 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
828 {
829         target->flags = source->flags;
830         target->rsize = source->rsize;
831         target->wsize = source->wsize;
832         target->acregmin = source->acregmin;
833         target->acregmax = source->acregmax;
834         target->acdirmin = source->acdirmin;
835         target->acdirmax = source->acdirmax;
836         target->caps = source->caps;
837         target->options = source->options;
838         target->auth_info = source->auth_info;
839         target->port = source->port;
840 }
841 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
842
843 void nfs_server_insert_lists(struct nfs_server *server)
844 {
845         struct nfs_client *clp = server->nfs_client;
846         struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
847
848         spin_lock(&nn->nfs_client_lock);
849         list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
850         list_add_tail(&server->master_link, &nn->nfs_volume_list);
851         clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
852         spin_unlock(&nn->nfs_client_lock);
853
854 }
855 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
856
857 void nfs_server_remove_lists(struct nfs_server *server)
858 {
859         struct nfs_client *clp = server->nfs_client;
860         struct nfs_net *nn;
861
862         if (clp == NULL)
863                 return;
864         nn = net_generic(clp->cl_net, nfs_net_id);
865         spin_lock(&nn->nfs_client_lock);
866         list_del_rcu(&server->client_link);
867         if (list_empty(&clp->cl_superblocks))
868                 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
869         list_del(&server->master_link);
870         spin_unlock(&nn->nfs_client_lock);
871
872         synchronize_rcu();
873 }
874 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
875
876 /*
877  * Allocate and initialise a server record
878  */
879 struct nfs_server *nfs_alloc_server(void)
880 {
881         struct nfs_server *server;
882
883         server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
884         if (!server)
885                 return NULL;
886
887         server->client = server->client_acl = ERR_PTR(-EINVAL);
888
889         /* Zero out the NFS state stuff */
890         INIT_LIST_HEAD(&server->client_link);
891         INIT_LIST_HEAD(&server->master_link);
892         INIT_LIST_HEAD(&server->delegations);
893         INIT_LIST_HEAD(&server->layouts);
894         INIT_LIST_HEAD(&server->state_owners_lru);
895         INIT_LIST_HEAD(&server->ss_copies);
896
897         atomic_set(&server->active, 0);
898
899         server->io_stats = nfs_alloc_iostats();
900         if (!server->io_stats) {
901                 kfree(server);
902                 return NULL;
903         }
904
905         ida_init(&server->openowner_id);
906         ida_init(&server->lockowner_id);
907         pnfs_init_server(server);
908         rpc_init_wait_queue(&server->uoc_rpcwaitq, "NFS UOC");
909
910         return server;
911 }
912 EXPORT_SYMBOL_GPL(nfs_alloc_server);
913
914 /*
915  * Free up a server record
916  */
917 void nfs_free_server(struct nfs_server *server)
918 {
919         nfs_server_remove_lists(server);
920
921         if (server->destroy != NULL)
922                 server->destroy(server);
923
924         if (!IS_ERR(server->client_acl))
925                 rpc_shutdown_client(server->client_acl);
926         if (!IS_ERR(server->client))
927                 rpc_shutdown_client(server->client);
928
929         nfs_put_client(server->nfs_client);
930
931         ida_destroy(&server->lockowner_id);
932         ida_destroy(&server->openowner_id);
933         nfs_free_iostats(server->io_stats);
934         kfree(server);
935         nfs_release_automount_timer();
936 }
937 EXPORT_SYMBOL_GPL(nfs_free_server);
938
939 /*
940  * Create a version 2 or 3 volume record
941  * - keyed on server and FSID
942  */
943 struct 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         error = -ENOMEM;
955         fattr = nfs_alloc_fattr();
956         if (fattr == NULL)
957                 goto error;
958
959         /* Get a client representation */
960         error = nfs_init_server(server, mount_info->parsed, nfs_mod);
961         if (error < 0)
962                 goto error;
963
964         /* Probe the root fh to retrieve its FSID */
965         error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
966         if (error < 0)
967                 goto error;
968         if (server->nfs_client->rpc_ops->version == 3) {
969                 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
970                         server->namelen = NFS3_MAXNAMLEN;
971                 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
972                         server->caps |= NFS_CAP_READDIRPLUS;
973         } else {
974                 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
975                         server->namelen = NFS2_MAXNAMLEN;
976         }
977
978         if (!(fattr->valid & NFS_ATTR_FATTR)) {
979                 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh,
980                                 fattr, NULL, NULL);
981                 if (error < 0) {
982                         dprintk("nfs_create_server: getattr error = %d\n", -error);
983                         goto error;
984                 }
985         }
986         memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
987
988         dprintk("Server FSID: %llx:%llx\n",
989                 (unsigned long long) server->fsid.major,
990                 (unsigned long long) server->fsid.minor);
991
992         nfs_server_insert_lists(server);
993         server->mount_time = jiffies;
994         nfs_free_fattr(fattr);
995         return server;
996
997 error:
998         nfs_free_fattr(fattr);
999         nfs_free_server(server);
1000         return ERR_PTR(error);
1001 }
1002 EXPORT_SYMBOL_GPL(nfs_create_server);
1003
1004 /*
1005  * Clone an NFS2, NFS3 or NFS4 server record
1006  */
1007 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1008                                     struct nfs_fh *fh,
1009                                     struct nfs_fattr *fattr,
1010                                     rpc_authflavor_t flavor)
1011 {
1012         struct nfs_server *server;
1013         struct nfs_fattr *fattr_fsinfo;
1014         int error;
1015
1016         server = nfs_alloc_server();
1017         if (!server)
1018                 return ERR_PTR(-ENOMEM);
1019
1020         error = -ENOMEM;
1021         fattr_fsinfo = nfs_alloc_fattr();
1022         if (fattr_fsinfo == NULL)
1023                 goto out_free_server;
1024
1025         /* Copy data from the source */
1026         server->nfs_client = source->nfs_client;
1027         server->destroy = source->destroy;
1028         refcount_inc(&server->nfs_client->cl_count);
1029         nfs_server_copy_userdata(server, source);
1030
1031         server->fsid = fattr->fsid;
1032
1033         error = nfs_init_server_rpcclient(server,
1034                         source->client->cl_timeout,
1035                         flavor);
1036         if (error < 0)
1037                 goto out_free_server;
1038
1039         /* probe the filesystem info for this server filesystem */
1040         error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1041         if (error < 0)
1042                 goto out_free_server;
1043
1044         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1045                 server->namelen = NFS4_MAXNAMLEN;
1046
1047         error = nfs_start_lockd(server);
1048         if (error < 0)
1049                 goto out_free_server;
1050
1051         nfs_server_insert_lists(server);
1052         server->mount_time = jiffies;
1053
1054         nfs_free_fattr(fattr_fsinfo);
1055         return server;
1056
1057 out_free_server:
1058         nfs_free_fattr(fattr_fsinfo);
1059         nfs_free_server(server);
1060         return ERR_PTR(error);
1061 }
1062 EXPORT_SYMBOL_GPL(nfs_clone_server);
1063
1064 void nfs_clients_init(struct net *net)
1065 {
1066         struct nfs_net *nn = net_generic(net, nfs_net_id);
1067
1068         INIT_LIST_HEAD(&nn->nfs_client_list);
1069         INIT_LIST_HEAD(&nn->nfs_volume_list);
1070 #if IS_ENABLED(CONFIG_NFS_V4)
1071         idr_init(&nn->cb_ident_idr);
1072 #endif
1073         spin_lock_init(&nn->nfs_client_lock);
1074         nn->boot_time = ktime_get_real();
1075 }
1076
1077 #ifdef CONFIG_PROC_FS
1078 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1079 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1080 static void nfs_server_list_stop(struct seq_file *p, void *v);
1081 static int nfs_server_list_show(struct seq_file *m, void *v);
1082
1083 static const struct seq_operations nfs_server_list_ops = {
1084         .start  = nfs_server_list_start,
1085         .next   = nfs_server_list_next,
1086         .stop   = nfs_server_list_stop,
1087         .show   = nfs_server_list_show,
1088 };
1089
1090 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1091 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1092 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1093 static int nfs_volume_list_show(struct seq_file *m, void *v);
1094
1095 static const struct seq_operations nfs_volume_list_ops = {
1096         .start  = nfs_volume_list_start,
1097         .next   = nfs_volume_list_next,
1098         .stop   = nfs_volume_list_stop,
1099         .show   = nfs_volume_list_show,
1100 };
1101
1102 /*
1103  * set up the iterator to start reading from the server list and return the first item
1104  */
1105 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1106                                 __acquires(&nn->nfs_client_lock)
1107 {
1108         struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1109
1110         /* lock the list against modification */
1111         spin_lock(&nn->nfs_client_lock);
1112         return seq_list_start_head(&nn->nfs_client_list, *_pos);
1113 }
1114
1115 /*
1116  * move to next server
1117  */
1118 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1119 {
1120         struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1121
1122         return seq_list_next(v, &nn->nfs_client_list, pos);
1123 }
1124
1125 /*
1126  * clean up after reading from the transports list
1127  */
1128 static void nfs_server_list_stop(struct seq_file *p, void *v)
1129                                 __releases(&nn->nfs_client_lock)
1130 {
1131         struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1132
1133         spin_unlock(&nn->nfs_client_lock);
1134 }
1135
1136 /*
1137  * display a header line followed by a load of call lines
1138  */
1139 static int nfs_server_list_show(struct seq_file *m, void *v)
1140 {
1141         struct nfs_client *clp;
1142         struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1143
1144         /* display header on line 1 */
1145         if (v == &nn->nfs_client_list) {
1146                 seq_puts(m, "NV SERVER   PORT USE HOSTNAME\n");
1147                 return 0;
1148         }
1149
1150         /* display one transport per line on subsequent lines */
1151         clp = list_entry(v, struct nfs_client, cl_share_link);
1152
1153         /* Check if the client is initialized */
1154         if (clp->cl_cons_state != NFS_CS_READY)
1155                 return 0;
1156
1157         rcu_read_lock();
1158         seq_printf(m, "v%u %s %s %3d %s\n",
1159                    clp->rpc_ops->version,
1160                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1161                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1162                    refcount_read(&clp->cl_count),
1163                    clp->cl_hostname);
1164         rcu_read_unlock();
1165
1166         return 0;
1167 }
1168
1169 /*
1170  * set up the iterator to start reading from the volume list and return the first item
1171  */
1172 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1173                                 __acquires(&nn->nfs_client_lock)
1174 {
1175         struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1176
1177         /* lock the list against modification */
1178         spin_lock(&nn->nfs_client_lock);
1179         return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1180 }
1181
1182 /*
1183  * move to next volume
1184  */
1185 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1186 {
1187         struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1188
1189         return seq_list_next(v, &nn->nfs_volume_list, pos);
1190 }
1191
1192 /*
1193  * clean up after reading from the transports list
1194  */
1195 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1196                                 __releases(&nn->nfs_client_lock)
1197 {
1198         struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1199
1200         spin_unlock(&nn->nfs_client_lock);
1201 }
1202
1203 /*
1204  * display a header line followed by a load of call lines
1205  */
1206 static int nfs_volume_list_show(struct seq_file *m, void *v)
1207 {
1208         struct nfs_server *server;
1209         struct nfs_client *clp;
1210         char dev[13];   // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1211         char fsid[34];  // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1212         struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1213
1214         /* display header on line 1 */
1215         if (v == &nn->nfs_volume_list) {
1216                 seq_puts(m, "NV SERVER   PORT DEV          FSID"
1217                             "                              FSC\n");
1218                 return 0;
1219         }
1220         /* display one transport per line on subsequent lines */
1221         server = list_entry(v, struct nfs_server, master_link);
1222         clp = server->nfs_client;
1223
1224         snprintf(dev, sizeof(dev), "%u:%u",
1225                  MAJOR(server->s_dev), MINOR(server->s_dev));
1226
1227         snprintf(fsid, sizeof(fsid), "%llx:%llx",
1228                  (unsigned long long) server->fsid.major,
1229                  (unsigned long long) server->fsid.minor);
1230
1231         rcu_read_lock();
1232         seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1233                    clp->rpc_ops->version,
1234                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1235                    rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1236                    dev,
1237                    fsid,
1238                    nfs_server_fscache_state(server));
1239         rcu_read_unlock();
1240
1241         return 0;
1242 }
1243
1244 int nfs_fs_proc_net_init(struct net *net)
1245 {
1246         struct nfs_net *nn = net_generic(net, nfs_net_id);
1247         struct proc_dir_entry *p;
1248
1249         nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1250         if (!nn->proc_nfsfs)
1251                 goto error_0;
1252
1253         /* a file of servers with which we're dealing */
1254         p = proc_create_net("servers", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1255                         &nfs_server_list_ops, sizeof(struct seq_net_private));
1256         if (!p)
1257                 goto error_1;
1258
1259         /* a file of volumes that we have mounted */
1260         p = proc_create_net("volumes", S_IFREG|S_IRUGO, nn->proc_nfsfs,
1261                         &nfs_volume_list_ops, sizeof(struct seq_net_private));
1262         if (!p)
1263                 goto error_1;
1264         return 0;
1265
1266 error_1:
1267         remove_proc_subtree("nfsfs", net->proc_net);
1268 error_0:
1269         return -ENOMEM;
1270 }
1271
1272 void nfs_fs_proc_net_exit(struct net *net)
1273 {
1274         remove_proc_subtree("nfsfs", net->proc_net);
1275 }
1276
1277 /*
1278  * initialise the /proc/fs/nfsfs/ directory
1279  */
1280 int __init nfs_fs_proc_init(void)
1281 {
1282         if (!proc_mkdir("fs/nfsfs", NULL))
1283                 goto error_0;
1284
1285         /* a file of servers with which we're dealing */
1286         if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1287                 goto error_1;
1288
1289         /* a file of volumes that we have mounted */
1290         if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1291                 goto error_1;
1292
1293         return 0;
1294 error_1:
1295         remove_proc_subtree("fs/nfsfs", NULL);
1296 error_0:
1297         return -ENOMEM;
1298 }
1299
1300 /*
1301  * clean up the /proc/fs/nfsfs/ directory
1302  */
1303 void nfs_fs_proc_exit(void)
1304 {
1305         remove_proc_subtree("fs/nfsfs", NULL);
1306 }
1307
1308 #endif /* CONFIG_PROC_FS */