Loading...
1/* client.c: NFS client sharing and management code
2 *
3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 */
11
12
13#include <linux/module.h>
14#include <linux/init.h>
15#include <linux/sched.h>
16#include <linux/time.h>
17#include <linux/kernel.h>
18#include <linux/mm.h>
19#include <linux/string.h>
20#include <linux/stat.h>
21#include <linux/errno.h>
22#include <linux/unistd.h>
23#include <linux/sunrpc/addr.h>
24#include <linux/sunrpc/clnt.h>
25#include <linux/sunrpc/stats.h>
26#include <linux/sunrpc/metrics.h>
27#include <linux/sunrpc/xprtsock.h>
28#include <linux/sunrpc/xprtrdma.h>
29#include <linux/nfs_fs.h>
30#include <linux/nfs_mount.h>
31#include <linux/nfs4_mount.h>
32#include <linux/lockd/bind.h>
33#include <linux/seq_file.h>
34#include <linux/mount.h>
35#include <linux/vfs.h>
36#include <linux/inet.h>
37#include <linux/in6.h>
38#include <linux/slab.h>
39#include <linux/idr.h>
40#include <net/ipv6.h>
41#include <linux/nfs_xdr.h>
42#include <linux/sunrpc/bc_xprt.h>
43#include <linux/nsproxy.h>
44#include <linux/pid_namespace.h>
45
46
47#include "nfs4_fs.h"
48#include "callback.h"
49#include "delegation.h"
50#include "iostat.h"
51#include "internal.h"
52#include "fscache.h"
53#include "pnfs.h"
54#include "nfs.h"
55#include "netns.h"
56
57#define NFSDBG_FACILITY NFSDBG_CLIENT
58
59static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
60static DEFINE_SPINLOCK(nfs_version_lock);
61static DEFINE_MUTEX(nfs_version_mutex);
62static LIST_HEAD(nfs_versions);
63
64/*
65 * RPC cruft for NFS
66 */
67static const struct rpc_version *nfs_version[5] = {
68 [2] = NULL,
69 [3] = NULL,
70 [4] = NULL,
71};
72
73const struct rpc_program nfs_program = {
74 .name = "nfs",
75 .number = NFS_PROGRAM,
76 .nrvers = ARRAY_SIZE(nfs_version),
77 .version = nfs_version,
78 .stats = &nfs_rpcstat,
79 .pipe_dir_name = NFS_PIPE_DIRNAME,
80};
81
82struct rpc_stat nfs_rpcstat = {
83 .program = &nfs_program
84};
85
86static struct nfs_subversion *find_nfs_version(unsigned int version)
87{
88 struct nfs_subversion *nfs;
89 spin_lock(&nfs_version_lock);
90
91 list_for_each_entry(nfs, &nfs_versions, list) {
92 if (nfs->rpc_ops->version == version) {
93 spin_unlock(&nfs_version_lock);
94 return nfs;
95 }
96 }
97
98 spin_unlock(&nfs_version_lock);
99 return ERR_PTR(-EPROTONOSUPPORT);
100}
101
102struct nfs_subversion *get_nfs_version(unsigned int version)
103{
104 struct nfs_subversion *nfs = find_nfs_version(version);
105
106 if (IS_ERR(nfs)) {
107 mutex_lock(&nfs_version_mutex);
108 request_module("nfsv%d", version);
109 nfs = find_nfs_version(version);
110 mutex_unlock(&nfs_version_mutex);
111 }
112
113 if (!IS_ERR(nfs) && !try_module_get(nfs->owner))
114 return ERR_PTR(-EAGAIN);
115 return nfs;
116}
117
118void put_nfs_version(struct nfs_subversion *nfs)
119{
120 module_put(nfs->owner);
121}
122
123void register_nfs_version(struct nfs_subversion *nfs)
124{
125 spin_lock(&nfs_version_lock);
126
127 list_add(&nfs->list, &nfs_versions);
128 nfs_version[nfs->rpc_ops->version] = nfs->rpc_vers;
129
130 spin_unlock(&nfs_version_lock);
131}
132EXPORT_SYMBOL_GPL(register_nfs_version);
133
134void unregister_nfs_version(struct nfs_subversion *nfs)
135{
136 spin_lock(&nfs_version_lock);
137
138 nfs_version[nfs->rpc_ops->version] = NULL;
139 list_del(&nfs->list);
140
141 spin_unlock(&nfs_version_lock);
142}
143EXPORT_SYMBOL_GPL(unregister_nfs_version);
144
145/*
146 * Allocate a shared client record
147 *
148 * Since these are allocated/deallocated very rarely, we don't
149 * bother putting them in a slab cache...
150 */
151struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
152{
153 struct nfs_client *clp;
154 struct rpc_cred *cred;
155 int err = -ENOMEM;
156
157 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
158 goto error_0;
159
160 clp->cl_nfs_mod = cl_init->nfs_mod;
161 if (!try_module_get(clp->cl_nfs_mod->owner))
162 goto error_dealloc;
163
164 clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
165
166 refcount_set(&clp->cl_count, 1);
167 clp->cl_cons_state = NFS_CS_INITING;
168
169 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
170 clp->cl_addrlen = cl_init->addrlen;
171
172 if (cl_init->hostname) {
173 err = -ENOMEM;
174 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
175 if (!clp->cl_hostname)
176 goto error_cleanup;
177 }
178
179 INIT_LIST_HEAD(&clp->cl_superblocks);
180 clp->cl_rpcclient = ERR_PTR(-EINVAL);
181
182 clp->cl_proto = cl_init->proto;
183 clp->cl_net = get_net(cl_init->net);
184
185 cred = rpc_lookup_machine_cred("*");
186 if (!IS_ERR(cred))
187 clp->cl_machine_cred = cred;
188 nfs_fscache_get_client_cookie(clp);
189
190 return clp;
191
192error_cleanup:
193 put_nfs_version(clp->cl_nfs_mod);
194error_dealloc:
195 kfree(clp);
196error_0:
197 return ERR_PTR(err);
198}
199EXPORT_SYMBOL_GPL(nfs_alloc_client);
200
201#if IS_ENABLED(CONFIG_NFS_V4)
202void nfs_cleanup_cb_ident_idr(struct net *net)
203{
204 struct nfs_net *nn = net_generic(net, nfs_net_id);
205
206 idr_destroy(&nn->cb_ident_idr);
207}
208
209/* nfs_client_lock held */
210static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
211{
212 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
213
214 if (clp->cl_cb_ident)
215 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
216}
217
218static void pnfs_init_server(struct nfs_server *server)
219{
220 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
221}
222
223#else
224void nfs_cleanup_cb_ident_idr(struct net *net)
225{
226}
227
228static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
229{
230}
231
232static void pnfs_init_server(struct nfs_server *server)
233{
234}
235
236#endif /* CONFIG_NFS_V4 */
237
238/*
239 * Destroy a shared client record
240 */
241void nfs_free_client(struct nfs_client *clp)
242{
243 nfs_fscache_release_client_cookie(clp);
244
245 /* -EIO all pending I/O */
246 if (!IS_ERR(clp->cl_rpcclient))
247 rpc_shutdown_client(clp->cl_rpcclient);
248
249 if (clp->cl_machine_cred != NULL)
250 put_rpccred(clp->cl_machine_cred);
251
252 put_net(clp->cl_net);
253 put_nfs_version(clp->cl_nfs_mod);
254 kfree(clp->cl_hostname);
255 kfree(clp->cl_acceptor);
256 kfree(clp);
257}
258EXPORT_SYMBOL_GPL(nfs_free_client);
259
260/*
261 * Release a reference to a shared client record
262 */
263void nfs_put_client(struct nfs_client *clp)
264{
265 struct nfs_net *nn;
266
267 if (!clp)
268 return;
269
270 nn = net_generic(clp->cl_net, nfs_net_id);
271
272 if (refcount_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
273 list_del(&clp->cl_share_link);
274 nfs_cb_idr_remove_locked(clp);
275 spin_unlock(&nn->nfs_client_lock);
276
277 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
278
279 clp->rpc_ops->free_client(clp);
280 }
281}
282EXPORT_SYMBOL_GPL(nfs_put_client);
283
284/*
285 * Find an nfs_client on the list that matches the initialisation data
286 * that is supplied.
287 */
288static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
289{
290 struct nfs_client *clp;
291 const struct sockaddr *sap = data->addr;
292 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
293
294again:
295 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
296 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
297 /* Don't match clients that failed to initialise properly */
298 if (clp->cl_cons_state < 0)
299 continue;
300
301 /* If a client is still initializing then we need to wait */
302 if (clp->cl_cons_state > NFS_CS_READY) {
303 refcount_inc(&clp->cl_count);
304 spin_unlock(&nn->nfs_client_lock);
305 nfs_wait_client_init_complete(clp);
306 nfs_put_client(clp);
307 spin_lock(&nn->nfs_client_lock);
308 goto again;
309 }
310
311 /* Different NFS versions cannot share the same nfs_client */
312 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
313 continue;
314
315 if (clp->cl_proto != data->proto)
316 continue;
317 /* Match nfsv4 minorversion */
318 if (clp->cl_minorversion != data->minorversion)
319 continue;
320 /* Match the full socket address */
321 if (!rpc_cmp_addr_port(sap, clap))
322 /* Match all xprt_switch full socket addresses */
323 if (IS_ERR(clp->cl_rpcclient) ||
324 !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
325 sap))
326 continue;
327
328 refcount_inc(&clp->cl_count);
329 return clp;
330 }
331 return NULL;
332}
333
334/*
335 * Return true if @clp is done initializing, false if still working on it.
336 *
337 * Use nfs_client_init_status to check if it was successful.
338 */
339bool nfs_client_init_is_complete(const struct nfs_client *clp)
340{
341 return clp->cl_cons_state <= NFS_CS_READY;
342}
343EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
344
345/*
346 * Return 0 if @clp was successfully initialized, -errno otherwise.
347 *
348 * This must be called *after* nfs_client_init_is_complete() returns true,
349 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
350 */
351int nfs_client_init_status(const struct nfs_client *clp)
352{
353 /* called without checking nfs_client_init_is_complete */
354 if (clp->cl_cons_state > NFS_CS_READY) {
355 WARN_ON_ONCE(1);
356 return -EINVAL;
357 }
358 return clp->cl_cons_state;
359}
360EXPORT_SYMBOL_GPL(nfs_client_init_status);
361
362int nfs_wait_client_init_complete(const struct nfs_client *clp)
363{
364 return wait_event_killable(nfs_client_active_wq,
365 nfs_client_init_is_complete(clp));
366}
367EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
368
369/*
370 * Found an existing client. Make sure it's ready before returning.
371 */
372static struct nfs_client *
373nfs_found_client(const struct nfs_client_initdata *cl_init,
374 struct nfs_client *clp)
375{
376 int error;
377
378 error = nfs_wait_client_init_complete(clp);
379 if (error < 0) {
380 nfs_put_client(clp);
381 return ERR_PTR(-ERESTARTSYS);
382 }
383
384 if (clp->cl_cons_state < NFS_CS_READY) {
385 error = clp->cl_cons_state;
386 nfs_put_client(clp);
387 return ERR_PTR(error);
388 }
389
390 smp_rmb();
391 return clp;
392}
393
394/*
395 * Look up a client by IP address and protocol version
396 * - creates a new record if one doesn't yet exist
397 */
398struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
399{
400 struct nfs_client *clp, *new = NULL;
401 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
402 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
403
404 if (cl_init->hostname == NULL) {
405 WARN_ON(1);
406 return NULL;
407 }
408
409 /* see if the client already exists */
410 do {
411 spin_lock(&nn->nfs_client_lock);
412
413 clp = nfs_match_client(cl_init);
414 if (clp) {
415 spin_unlock(&nn->nfs_client_lock);
416 if (new)
417 new->rpc_ops->free_client(new);
418 return nfs_found_client(cl_init, clp);
419 }
420 if (new) {
421 list_add_tail(&new->cl_share_link,
422 &nn->nfs_client_list);
423 spin_unlock(&nn->nfs_client_lock);
424 new->cl_flags = cl_init->init_flags;
425 return rpc_ops->init_client(new, cl_init);
426 }
427
428 spin_unlock(&nn->nfs_client_lock);
429
430 new = rpc_ops->alloc_client(cl_init);
431 } while (!IS_ERR(new));
432
433 return new;
434}
435EXPORT_SYMBOL_GPL(nfs_get_client);
436
437/*
438 * Mark a server as ready or failed
439 */
440void nfs_mark_client_ready(struct nfs_client *clp, int state)
441{
442 smp_wmb();
443 clp->cl_cons_state = state;
444 wake_up_all(&nfs_client_active_wq);
445}
446EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
447
448/*
449 * Initialise the timeout values for a connection
450 */
451void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
452 int timeo, int retrans)
453{
454 to->to_initval = timeo * HZ / 10;
455 to->to_retries = retrans;
456
457 switch (proto) {
458 case XPRT_TRANSPORT_TCP:
459 case XPRT_TRANSPORT_RDMA:
460 if (retrans == NFS_UNSPEC_RETRANS)
461 to->to_retries = NFS_DEF_TCP_RETRANS;
462 if (timeo == NFS_UNSPEC_TIMEO || to->to_retries == 0)
463 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
464 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
465 to->to_initval = NFS_MAX_TCP_TIMEOUT;
466 to->to_increment = to->to_initval;
467 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
468 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
469 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
470 if (to->to_maxval < to->to_initval)
471 to->to_maxval = to->to_initval;
472 to->to_exponential = 0;
473 break;
474 case XPRT_TRANSPORT_UDP:
475 if (retrans == NFS_UNSPEC_RETRANS)
476 to->to_retries = NFS_DEF_UDP_RETRANS;
477 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
478 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
479 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
480 to->to_initval = NFS_MAX_UDP_TIMEOUT;
481 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
482 to->to_exponential = 1;
483 break;
484 default:
485 BUG();
486 }
487}
488EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
489
490/*
491 * Create an RPC client handle
492 */
493int nfs_create_rpc_client(struct nfs_client *clp,
494 const struct nfs_client_initdata *cl_init,
495 rpc_authflavor_t flavor)
496{
497 struct rpc_clnt *clnt = NULL;
498 struct rpc_create_args args = {
499 .net = clp->cl_net,
500 .protocol = clp->cl_proto,
501 .address = (struct sockaddr *)&clp->cl_addr,
502 .addrsize = clp->cl_addrlen,
503 .timeout = cl_init->timeparms,
504 .servername = clp->cl_hostname,
505 .nodename = cl_init->nodename,
506 .program = &nfs_program,
507 .version = clp->rpc_ops->version,
508 .authflavor = flavor,
509 };
510
511 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
512 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
513 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
514 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
515 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
516 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
517 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
518 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
519
520 if (!IS_ERR(clp->cl_rpcclient))
521 return 0;
522
523 clnt = rpc_create(&args);
524 if (IS_ERR(clnt)) {
525 dprintk("%s: cannot create RPC client. Error = %ld\n",
526 __func__, PTR_ERR(clnt));
527 return PTR_ERR(clnt);
528 }
529
530 clp->cl_rpcclient = clnt;
531 return 0;
532}
533EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
534
535/*
536 * Version 2 or 3 client destruction
537 */
538static void nfs_destroy_server(struct nfs_server *server)
539{
540 if (server->nlm_host)
541 nlmclnt_done(server->nlm_host);
542}
543
544/*
545 * Version 2 or 3 lockd setup
546 */
547static int nfs_start_lockd(struct nfs_server *server)
548{
549 struct nlm_host *host;
550 struct nfs_client *clp = server->nfs_client;
551 struct nlmclnt_initdata nlm_init = {
552 .hostname = clp->cl_hostname,
553 .address = (struct sockaddr *)&clp->cl_addr,
554 .addrlen = clp->cl_addrlen,
555 .nfs_version = clp->rpc_ops->version,
556 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
557 1 : 0,
558 .net = clp->cl_net,
559 .nlmclnt_ops = clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
560 };
561
562 if (nlm_init.nfs_version > 3)
563 return 0;
564 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
565 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
566 return 0;
567
568 switch (clp->cl_proto) {
569 default:
570 nlm_init.protocol = IPPROTO_TCP;
571 break;
572 case XPRT_TRANSPORT_UDP:
573 nlm_init.protocol = IPPROTO_UDP;
574 }
575
576 host = nlmclnt_init(&nlm_init);
577 if (IS_ERR(host))
578 return PTR_ERR(host);
579
580 server->nlm_host = host;
581 server->destroy = nfs_destroy_server;
582 return 0;
583}
584
585/*
586 * Create a general RPC client
587 */
588int nfs_init_server_rpcclient(struct nfs_server *server,
589 const struct rpc_timeout *timeo,
590 rpc_authflavor_t pseudoflavour)
591{
592 struct nfs_client *clp = server->nfs_client;
593
594 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
595 pseudoflavour);
596 if (IS_ERR(server->client)) {
597 dprintk("%s: couldn't create rpc_client!\n", __func__);
598 return PTR_ERR(server->client);
599 }
600
601 memcpy(&server->client->cl_timeout_default,
602 timeo,
603 sizeof(server->client->cl_timeout_default));
604 server->client->cl_timeout = &server->client->cl_timeout_default;
605 server->client->cl_softrtry = 0;
606 if (server->flags & NFS_MOUNT_SOFT)
607 server->client->cl_softrtry = 1;
608
609 return 0;
610}
611EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
612
613/**
614 * nfs_init_client - Initialise an NFS2 or NFS3 client
615 *
616 * @clp: nfs_client to initialise
617 * @cl_init: Initialisation parameters
618 *
619 * Returns pointer to an NFS client, or an ERR_PTR value.
620 */
621struct nfs_client *nfs_init_client(struct nfs_client *clp,
622 const struct nfs_client_initdata *cl_init)
623{
624 int error;
625
626 /* the client is already initialised */
627 if (clp->cl_cons_state == NFS_CS_READY)
628 return clp;
629
630 /*
631 * Create a client RPC handle for doing FSSTAT with UNIX auth only
632 * - RFC 2623, sec 2.3.2
633 */
634 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
635 nfs_mark_client_ready(clp, error == 0 ? NFS_CS_READY : error);
636 if (error < 0) {
637 nfs_put_client(clp);
638 clp = ERR_PTR(error);
639 }
640 return clp;
641}
642EXPORT_SYMBOL_GPL(nfs_init_client);
643
644/*
645 * Create a version 2 or 3 client
646 */
647static int nfs_init_server(struct nfs_server *server,
648 const struct nfs_parsed_mount_data *data,
649 struct nfs_subversion *nfs_mod)
650{
651 struct rpc_timeout timeparms;
652 struct nfs_client_initdata cl_init = {
653 .hostname = data->nfs_server.hostname,
654 .addr = (const struct sockaddr *)&data->nfs_server.address,
655 .addrlen = data->nfs_server.addrlen,
656 .nfs_mod = nfs_mod,
657 .proto = data->nfs_server.protocol,
658 .net = data->net,
659 .timeparms = &timeparms,
660 };
661 struct nfs_client *clp;
662 int error;
663
664 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
665 data->timeo, data->retrans);
666 if (data->flags & NFS_MOUNT_NORESVPORT)
667 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
668
669 /* Allocate or find a client reference we can use */
670 clp = nfs_get_client(&cl_init);
671 if (IS_ERR(clp))
672 return PTR_ERR(clp);
673
674 server->nfs_client = clp;
675
676 /* Initialise the client representation from the mount data */
677 server->flags = data->flags;
678 server->options = data->options;
679 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
680 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
681 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
682
683 if (data->rsize)
684 server->rsize = nfs_block_size(data->rsize, NULL);
685 if (data->wsize)
686 server->wsize = nfs_block_size(data->wsize, NULL);
687
688 server->acregmin = data->acregmin * HZ;
689 server->acregmax = data->acregmax * HZ;
690 server->acdirmin = data->acdirmin * HZ;
691 server->acdirmax = data->acdirmax * HZ;
692
693 /* Start lockd here, before we might error out */
694 error = nfs_start_lockd(server);
695 if (error < 0)
696 goto error;
697
698 server->port = data->nfs_server.port;
699 server->auth_info = data->auth_info;
700
701 error = nfs_init_server_rpcclient(server, &timeparms,
702 data->selected_flavor);
703 if (error < 0)
704 goto error;
705
706 /* Preserve the values of mount_server-related mount options */
707 if (data->mount_server.addrlen) {
708 memcpy(&server->mountd_address, &data->mount_server.address,
709 data->mount_server.addrlen);
710 server->mountd_addrlen = data->mount_server.addrlen;
711 }
712 server->mountd_version = data->mount_server.version;
713 server->mountd_port = data->mount_server.port;
714 server->mountd_protocol = data->mount_server.protocol;
715
716 server->namelen = data->namlen;
717 return 0;
718
719error:
720 server->nfs_client = NULL;
721 nfs_put_client(clp);
722 return error;
723}
724
725/*
726 * Load up the server record from information gained in an fsinfo record
727 */
728static void nfs_server_set_fsinfo(struct nfs_server *server,
729 struct nfs_fsinfo *fsinfo)
730{
731 unsigned long max_rpc_payload;
732
733 /* Work out a lot of parameters */
734 if (server->rsize == 0)
735 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
736 if (server->wsize == 0)
737 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
738
739 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
740 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
741 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
742 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
743
744 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
745 if (server->rsize > max_rpc_payload)
746 server->rsize = max_rpc_payload;
747 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
748 server->rsize = NFS_MAX_FILE_IO_SIZE;
749 server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
750
751 if (server->wsize > max_rpc_payload)
752 server->wsize = max_rpc_payload;
753 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
754 server->wsize = NFS_MAX_FILE_IO_SIZE;
755 server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
756
757 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
758
759 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
760 if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
761 server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
762 if (server->dtsize > server->rsize)
763 server->dtsize = server->rsize;
764
765 if (server->flags & NFS_MOUNT_NOAC) {
766 server->acregmin = server->acregmax = 0;
767 server->acdirmin = server->acdirmax = 0;
768 }
769
770 server->maxfilesize = fsinfo->maxfilesize;
771
772 server->time_delta = fsinfo->time_delta;
773
774 server->clone_blksize = fsinfo->clone_blksize;
775 /* We're airborne Set socket buffersize */
776 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
777}
778
779/*
780 * Probe filesystem information, including the FSID on v2/v3
781 */
782int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
783{
784 struct nfs_fsinfo fsinfo;
785 struct nfs_client *clp = server->nfs_client;
786 int error;
787
788 if (clp->rpc_ops->set_capabilities != NULL) {
789 error = clp->rpc_ops->set_capabilities(server, mntfh);
790 if (error < 0)
791 return error;
792 }
793
794 fsinfo.fattr = fattr;
795 fsinfo.nlayouttypes = 0;
796 memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
797 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
798 if (error < 0)
799 return error;
800
801 nfs_server_set_fsinfo(server, &fsinfo);
802
803 /* Get some general file system info */
804 if (server->namelen == 0) {
805 struct nfs_pathconf pathinfo;
806
807 pathinfo.fattr = fattr;
808 nfs_fattr_init(fattr);
809
810 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
811 server->namelen = pathinfo.max_namelen;
812 }
813
814 return 0;
815}
816EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
817
818/*
819 * Copy useful information when duplicating a server record
820 */
821void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
822{
823 target->flags = source->flags;
824 target->rsize = source->rsize;
825 target->wsize = source->wsize;
826 target->acregmin = source->acregmin;
827 target->acregmax = source->acregmax;
828 target->acdirmin = source->acdirmin;
829 target->acdirmax = source->acdirmax;
830 target->caps = source->caps;
831 target->options = source->options;
832 target->auth_info = source->auth_info;
833 target->port = source->port;
834}
835EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
836
837void nfs_server_insert_lists(struct nfs_server *server)
838{
839 struct nfs_client *clp = server->nfs_client;
840 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
841
842 spin_lock(&nn->nfs_client_lock);
843 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
844 list_add_tail(&server->master_link, &nn->nfs_volume_list);
845 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
846 spin_unlock(&nn->nfs_client_lock);
847
848}
849EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
850
851void nfs_server_remove_lists(struct nfs_server *server)
852{
853 struct nfs_client *clp = server->nfs_client;
854 struct nfs_net *nn;
855
856 if (clp == NULL)
857 return;
858 nn = net_generic(clp->cl_net, nfs_net_id);
859 spin_lock(&nn->nfs_client_lock);
860 list_del_rcu(&server->client_link);
861 if (list_empty(&clp->cl_superblocks))
862 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
863 list_del(&server->master_link);
864 spin_unlock(&nn->nfs_client_lock);
865
866 synchronize_rcu();
867}
868EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
869
870/*
871 * Allocate and initialise a server record
872 */
873struct nfs_server *nfs_alloc_server(void)
874{
875 struct nfs_server *server;
876
877 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
878 if (!server)
879 return NULL;
880
881 server->client = server->client_acl = ERR_PTR(-EINVAL);
882
883 /* Zero out the NFS state stuff */
884 INIT_LIST_HEAD(&server->client_link);
885 INIT_LIST_HEAD(&server->master_link);
886 INIT_LIST_HEAD(&server->delegations);
887 INIT_LIST_HEAD(&server->layouts);
888 INIT_LIST_HEAD(&server->state_owners_lru);
889
890 atomic_set(&server->active, 0);
891
892 server->io_stats = nfs_alloc_iostats();
893 if (!server->io_stats) {
894 kfree(server);
895 return NULL;
896 }
897
898 ida_init(&server->openowner_id);
899 ida_init(&server->lockowner_id);
900 pnfs_init_server(server);
901 rpc_init_wait_queue(&server->uoc_rpcwaitq, "NFS UOC");
902
903 return server;
904}
905EXPORT_SYMBOL_GPL(nfs_alloc_server);
906
907/*
908 * Free up a server record
909 */
910void nfs_free_server(struct nfs_server *server)
911{
912 nfs_server_remove_lists(server);
913
914 if (server->destroy != NULL)
915 server->destroy(server);
916
917 if (!IS_ERR(server->client_acl))
918 rpc_shutdown_client(server->client_acl);
919 if (!IS_ERR(server->client))
920 rpc_shutdown_client(server->client);
921
922 nfs_put_client(server->nfs_client);
923
924 ida_destroy(&server->lockowner_id);
925 ida_destroy(&server->openowner_id);
926 nfs_free_iostats(server->io_stats);
927 kfree(server);
928 nfs_release_automount_timer();
929}
930EXPORT_SYMBOL_GPL(nfs_free_server);
931
932/*
933 * Create a version 2 or 3 volume record
934 * - keyed on server and FSID
935 */
936struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
937 struct nfs_subversion *nfs_mod)
938{
939 struct nfs_server *server;
940 struct nfs_fattr *fattr;
941 int error;
942
943 server = nfs_alloc_server();
944 if (!server)
945 return ERR_PTR(-ENOMEM);
946
947 error = -ENOMEM;
948 fattr = nfs_alloc_fattr();
949 if (fattr == NULL)
950 goto error;
951
952 /* Get a client representation */
953 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
954 if (error < 0)
955 goto error;
956
957 /* Probe the root fh to retrieve its FSID */
958 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
959 if (error < 0)
960 goto error;
961 if (server->nfs_client->rpc_ops->version == 3) {
962 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
963 server->namelen = NFS3_MAXNAMLEN;
964 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
965 server->caps |= NFS_CAP_READDIRPLUS;
966 } else {
967 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
968 server->namelen = NFS2_MAXNAMLEN;
969 }
970
971 if (!(fattr->valid & NFS_ATTR_FATTR)) {
972 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr, NULL);
973 if (error < 0) {
974 dprintk("nfs_create_server: getattr error = %d\n", -error);
975 goto error;
976 }
977 }
978 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
979
980 dprintk("Server FSID: %llx:%llx\n",
981 (unsigned long long) server->fsid.major,
982 (unsigned long long) server->fsid.minor);
983
984 nfs_server_insert_lists(server);
985 server->mount_time = jiffies;
986 nfs_free_fattr(fattr);
987 return server;
988
989error:
990 nfs_free_fattr(fattr);
991 nfs_free_server(server);
992 return ERR_PTR(error);
993}
994EXPORT_SYMBOL_GPL(nfs_create_server);
995
996/*
997 * Clone an NFS2, NFS3 or NFS4 server record
998 */
999struct nfs_server *nfs_clone_server(struct nfs_server *source,
1000 struct nfs_fh *fh,
1001 struct nfs_fattr *fattr,
1002 rpc_authflavor_t flavor)
1003{
1004 struct nfs_server *server;
1005 struct nfs_fattr *fattr_fsinfo;
1006 int error;
1007
1008 server = nfs_alloc_server();
1009 if (!server)
1010 return ERR_PTR(-ENOMEM);
1011
1012 error = -ENOMEM;
1013 fattr_fsinfo = nfs_alloc_fattr();
1014 if (fattr_fsinfo == NULL)
1015 goto out_free_server;
1016
1017 /* Copy data from the source */
1018 server->nfs_client = source->nfs_client;
1019 server->destroy = source->destroy;
1020 refcount_inc(&server->nfs_client->cl_count);
1021 nfs_server_copy_userdata(server, source);
1022
1023 server->fsid = fattr->fsid;
1024
1025 error = nfs_init_server_rpcclient(server,
1026 source->client->cl_timeout,
1027 flavor);
1028 if (error < 0)
1029 goto out_free_server;
1030
1031 /* probe the filesystem info for this server filesystem */
1032 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1033 if (error < 0)
1034 goto out_free_server;
1035
1036 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1037 server->namelen = NFS4_MAXNAMLEN;
1038
1039 error = nfs_start_lockd(server);
1040 if (error < 0)
1041 goto out_free_server;
1042
1043 nfs_server_insert_lists(server);
1044 server->mount_time = jiffies;
1045
1046 nfs_free_fattr(fattr_fsinfo);
1047 return server;
1048
1049out_free_server:
1050 nfs_free_fattr(fattr_fsinfo);
1051 nfs_free_server(server);
1052 return ERR_PTR(error);
1053}
1054EXPORT_SYMBOL_GPL(nfs_clone_server);
1055
1056void nfs_clients_init(struct net *net)
1057{
1058 struct nfs_net *nn = net_generic(net, nfs_net_id);
1059
1060 INIT_LIST_HEAD(&nn->nfs_client_list);
1061 INIT_LIST_HEAD(&nn->nfs_volume_list);
1062#if IS_ENABLED(CONFIG_NFS_V4)
1063 idr_init(&nn->cb_ident_idr);
1064#endif
1065 spin_lock_init(&nn->nfs_client_lock);
1066 nn->boot_time = ktime_get_real();
1067}
1068
1069#ifdef CONFIG_PROC_FS
1070static int nfs_server_list_open(struct inode *inode, struct file *file);
1071static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1072static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1073static void nfs_server_list_stop(struct seq_file *p, void *v);
1074static int nfs_server_list_show(struct seq_file *m, void *v);
1075
1076static const struct seq_operations nfs_server_list_ops = {
1077 .start = nfs_server_list_start,
1078 .next = nfs_server_list_next,
1079 .stop = nfs_server_list_stop,
1080 .show = nfs_server_list_show,
1081};
1082
1083static const struct file_operations nfs_server_list_fops = {
1084 .open = nfs_server_list_open,
1085 .read = seq_read,
1086 .llseek = seq_lseek,
1087 .release = seq_release_net,
1088};
1089
1090static int nfs_volume_list_open(struct inode *inode, struct file *file);
1091static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1092static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1093static void nfs_volume_list_stop(struct seq_file *p, void *v);
1094static int nfs_volume_list_show(struct seq_file *m, void *v);
1095
1096static const struct seq_operations nfs_volume_list_ops = {
1097 .start = nfs_volume_list_start,
1098 .next = nfs_volume_list_next,
1099 .stop = nfs_volume_list_stop,
1100 .show = nfs_volume_list_show,
1101};
1102
1103static const struct file_operations nfs_volume_list_fops = {
1104 .open = nfs_volume_list_open,
1105 .read = seq_read,
1106 .llseek = seq_lseek,
1107 .release = seq_release_net,
1108};
1109
1110/*
1111 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1112 * we're dealing
1113 */
1114static int nfs_server_list_open(struct inode *inode, struct file *file)
1115{
1116 return seq_open_net(inode, file, &nfs_server_list_ops,
1117 sizeof(struct seq_net_private));
1118}
1119
1120/*
1121 * set up the iterator to start reading from the server list and return the first item
1122 */
1123static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1124 __acquires(&nn->nfs_client_lock)
1125{
1126 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1127
1128 /* lock the list against modification */
1129 spin_lock(&nn->nfs_client_lock);
1130 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1131}
1132
1133/*
1134 * move to next server
1135 */
1136static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1137{
1138 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1139
1140 return seq_list_next(v, &nn->nfs_client_list, pos);
1141}
1142
1143/*
1144 * clean up after reading from the transports list
1145 */
1146static void nfs_server_list_stop(struct seq_file *p, void *v)
1147 __releases(&nn->nfs_client_lock)
1148{
1149 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1150
1151 spin_unlock(&nn->nfs_client_lock);
1152}
1153
1154/*
1155 * display a header line followed by a load of call lines
1156 */
1157static int nfs_server_list_show(struct seq_file *m, void *v)
1158{
1159 struct nfs_client *clp;
1160 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1161
1162 /* display header on line 1 */
1163 if (v == &nn->nfs_client_list) {
1164 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1165 return 0;
1166 }
1167
1168 /* display one transport per line on subsequent lines */
1169 clp = list_entry(v, struct nfs_client, cl_share_link);
1170
1171 /* Check if the client is initialized */
1172 if (clp->cl_cons_state != NFS_CS_READY)
1173 return 0;
1174
1175 rcu_read_lock();
1176 seq_printf(m, "v%u %s %s %3d %s\n",
1177 clp->rpc_ops->version,
1178 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1179 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1180 refcount_read(&clp->cl_count),
1181 clp->cl_hostname);
1182 rcu_read_unlock();
1183
1184 return 0;
1185}
1186
1187/*
1188 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1189 */
1190static int nfs_volume_list_open(struct inode *inode, struct file *file)
1191{
1192 return seq_open_net(inode, file, &nfs_volume_list_ops,
1193 sizeof(struct seq_net_private));
1194}
1195
1196/*
1197 * set up the iterator to start reading from the volume list and return the first item
1198 */
1199static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1200 __acquires(&nn->nfs_client_lock)
1201{
1202 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1203
1204 /* lock the list against modification */
1205 spin_lock(&nn->nfs_client_lock);
1206 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1207}
1208
1209/*
1210 * move to next volume
1211 */
1212static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1213{
1214 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1215
1216 return seq_list_next(v, &nn->nfs_volume_list, pos);
1217}
1218
1219/*
1220 * clean up after reading from the transports list
1221 */
1222static void nfs_volume_list_stop(struct seq_file *p, void *v)
1223 __releases(&nn->nfs_client_lock)
1224{
1225 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1226
1227 spin_unlock(&nn->nfs_client_lock);
1228}
1229
1230/*
1231 * display a header line followed by a load of call lines
1232 */
1233static int nfs_volume_list_show(struct seq_file *m, void *v)
1234{
1235 struct nfs_server *server;
1236 struct nfs_client *clp;
1237 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1238 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1239 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1240
1241 /* display header on line 1 */
1242 if (v == &nn->nfs_volume_list) {
1243 seq_puts(m, "NV SERVER PORT DEV FSID"
1244 " FSC\n");
1245 return 0;
1246 }
1247 /* display one transport per line on subsequent lines */
1248 server = list_entry(v, struct nfs_server, master_link);
1249 clp = server->nfs_client;
1250
1251 snprintf(dev, sizeof(dev), "%u:%u",
1252 MAJOR(server->s_dev), MINOR(server->s_dev));
1253
1254 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1255 (unsigned long long) server->fsid.major,
1256 (unsigned long long) server->fsid.minor);
1257
1258 rcu_read_lock();
1259 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1260 clp->rpc_ops->version,
1261 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1262 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1263 dev,
1264 fsid,
1265 nfs_server_fscache_state(server));
1266 rcu_read_unlock();
1267
1268 return 0;
1269}
1270
1271int nfs_fs_proc_net_init(struct net *net)
1272{
1273 struct nfs_net *nn = net_generic(net, nfs_net_id);
1274 struct proc_dir_entry *p;
1275
1276 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1277 if (!nn->proc_nfsfs)
1278 goto error_0;
1279
1280 /* a file of servers with which we're dealing */
1281 p = proc_create("servers", S_IFREG|S_IRUGO,
1282 nn->proc_nfsfs, &nfs_server_list_fops);
1283 if (!p)
1284 goto error_1;
1285
1286 /* a file of volumes that we have mounted */
1287 p = proc_create("volumes", S_IFREG|S_IRUGO,
1288 nn->proc_nfsfs, &nfs_volume_list_fops);
1289 if (!p)
1290 goto error_1;
1291 return 0;
1292
1293error_1:
1294 remove_proc_subtree("nfsfs", net->proc_net);
1295error_0:
1296 return -ENOMEM;
1297}
1298
1299void nfs_fs_proc_net_exit(struct net *net)
1300{
1301 remove_proc_subtree("nfsfs", net->proc_net);
1302}
1303
1304/*
1305 * initialise the /proc/fs/nfsfs/ directory
1306 */
1307int __init nfs_fs_proc_init(void)
1308{
1309 if (!proc_mkdir("fs/nfsfs", NULL))
1310 goto error_0;
1311
1312 /* a file of servers with which we're dealing */
1313 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1314 goto error_1;
1315
1316 /* a file of volumes that we have mounted */
1317 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1318 goto error_1;
1319
1320 return 0;
1321error_1:
1322 remove_proc_subtree("fs/nfsfs", NULL);
1323error_0:
1324 return -ENOMEM;
1325}
1326
1327/*
1328 * clean up the /proc/fs/nfsfs/ directory
1329 */
1330void nfs_fs_proc_exit(void)
1331{
1332 remove_proc_subtree("fs/nfsfs", NULL);
1333}
1334
1335#endif /* CONFIG_PROC_FS */
1/* 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/clnt.h>
24#include <linux/sunrpc/stats.h>
25#include <linux/sunrpc/metrics.h>
26#include <linux/sunrpc/xprtsock.h>
27#include <linux/sunrpc/xprtrdma.h>
28#include <linux/nfs_fs.h>
29#include <linux/nfs_mount.h>
30#include <linux/nfs4_mount.h>
31#include <linux/lockd/bind.h>
32#include <linux/seq_file.h>
33#include <linux/mount.h>
34#include <linux/nfs_idmap.h>
35#include <linux/vfs.h>
36#include <linux/inet.h>
37#include <linux/in6.h>
38#include <linux/slab.h>
39#include <net/ipv6.h>
40#include <linux/nfs_xdr.h>
41#include <linux/sunrpc/bc_xprt.h>
42
43#include <asm/system.h>
44
45#include "nfs4_fs.h"
46#include "callback.h"
47#include "delegation.h"
48#include "iostat.h"
49#include "internal.h"
50#include "fscache.h"
51#include "pnfs.h"
52
53#define NFSDBG_FACILITY NFSDBG_CLIENT
54
55static DEFINE_SPINLOCK(nfs_client_lock);
56static LIST_HEAD(nfs_client_list);
57static LIST_HEAD(nfs_volume_list);
58static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
59#ifdef CONFIG_NFS_V4
60static DEFINE_IDR(cb_ident_idr); /* Protected by nfs_client_lock */
61
62/*
63 * Get a unique NFSv4.0 callback identifier which will be used
64 * by the V4.0 callback service to lookup the nfs_client struct
65 */
66static int nfs_get_cb_ident_idr(struct nfs_client *clp, int minorversion)
67{
68 int ret = 0;
69
70 if (clp->rpc_ops->version != 4 || minorversion != 0)
71 return ret;
72retry:
73 if (!idr_pre_get(&cb_ident_idr, GFP_KERNEL))
74 return -ENOMEM;
75 spin_lock(&nfs_client_lock);
76 ret = idr_get_new(&cb_ident_idr, clp, &clp->cl_cb_ident);
77 spin_unlock(&nfs_client_lock);
78 if (ret == -EAGAIN)
79 goto retry;
80 return ret;
81}
82#endif /* CONFIG_NFS_V4 */
83
84/*
85 * Turn off NFSv4 uid/gid mapping when using AUTH_SYS
86 */
87static int nfs4_disable_idmapping = 0;
88
89/*
90 * RPC cruft for NFS
91 */
92static struct rpc_version *nfs_version[5] = {
93 [2] = &nfs_version2,
94#ifdef CONFIG_NFS_V3
95 [3] = &nfs_version3,
96#endif
97#ifdef CONFIG_NFS_V4
98 [4] = &nfs_version4,
99#endif
100};
101
102struct rpc_program nfs_program = {
103 .name = "nfs",
104 .number = NFS_PROGRAM,
105 .nrvers = ARRAY_SIZE(nfs_version),
106 .version = nfs_version,
107 .stats = &nfs_rpcstat,
108 .pipe_dir_name = NFS_PIPE_DIRNAME,
109};
110
111struct rpc_stat nfs_rpcstat = {
112 .program = &nfs_program
113};
114
115
116#ifdef CONFIG_NFS_V3_ACL
117static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
118static struct rpc_version * nfsacl_version[] = {
119 [3] = &nfsacl_version3,
120};
121
122struct rpc_program nfsacl_program = {
123 .name = "nfsacl",
124 .number = NFS_ACL_PROGRAM,
125 .nrvers = ARRAY_SIZE(nfsacl_version),
126 .version = nfsacl_version,
127 .stats = &nfsacl_rpcstat,
128};
129#endif /* CONFIG_NFS_V3_ACL */
130
131struct nfs_client_initdata {
132 const char *hostname;
133 const struct sockaddr *addr;
134 size_t addrlen;
135 const struct nfs_rpc_ops *rpc_ops;
136 int proto;
137 u32 minorversion;
138};
139
140/*
141 * Allocate a shared client record
142 *
143 * Since these are allocated/deallocated very rarely, we don't
144 * bother putting them in a slab cache...
145 */
146static struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
147{
148 struct nfs_client *clp;
149 struct rpc_cred *cred;
150 int err = -ENOMEM;
151
152 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
153 goto error_0;
154
155 clp->rpc_ops = cl_init->rpc_ops;
156
157 atomic_set(&clp->cl_count, 1);
158 clp->cl_cons_state = NFS_CS_INITING;
159
160 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
161 clp->cl_addrlen = cl_init->addrlen;
162
163 if (cl_init->hostname) {
164 err = -ENOMEM;
165 clp->cl_hostname = kstrdup(cl_init->hostname, GFP_KERNEL);
166 if (!clp->cl_hostname)
167 goto error_cleanup;
168 }
169
170 INIT_LIST_HEAD(&clp->cl_superblocks);
171 clp->cl_rpcclient = ERR_PTR(-EINVAL);
172
173 clp->cl_proto = cl_init->proto;
174
175#ifdef CONFIG_NFS_V4
176 err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
177 if (err)
178 goto error_cleanup;
179
180 spin_lock_init(&clp->cl_lock);
181 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
182 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
183 clp->cl_boot_time = CURRENT_TIME;
184 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
185 clp->cl_minorversion = cl_init->minorversion;
186 clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
187#endif
188 cred = rpc_lookup_machine_cred();
189 if (!IS_ERR(cred))
190 clp->cl_machine_cred = cred;
191 nfs_fscache_get_client_cookie(clp);
192
193 return clp;
194
195error_cleanup:
196 kfree(clp);
197error_0:
198 return ERR_PTR(err);
199}
200
201#ifdef CONFIG_NFS_V4
202#ifdef CONFIG_NFS_V4_1
203static void nfs4_shutdown_session(struct nfs_client *clp)
204{
205 if (nfs4_has_session(clp))
206 nfs4_destroy_session(clp->cl_session);
207}
208#else /* CONFIG_NFS_V4_1 */
209static void nfs4_shutdown_session(struct nfs_client *clp)
210{
211}
212#endif /* CONFIG_NFS_V4_1 */
213
214/*
215 * Destroy the NFS4 callback service
216 */
217static void nfs4_destroy_callback(struct nfs_client *clp)
218{
219 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
220 nfs_callback_down(clp->cl_mvops->minor_version);
221}
222
223static void nfs4_shutdown_client(struct nfs_client *clp)
224{
225 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
226 nfs4_kill_renewd(clp);
227 nfs4_shutdown_session(clp);
228 nfs4_destroy_callback(clp);
229 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
230 nfs_idmap_delete(clp);
231
232 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
233}
234
235/* idr_remove_all is not needed as all id's are removed by nfs_put_client */
236void nfs_cleanup_cb_ident_idr(void)
237{
238 idr_destroy(&cb_ident_idr);
239}
240
241/* nfs_client_lock held */
242static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
243{
244 if (clp->cl_cb_ident)
245 idr_remove(&cb_ident_idr, clp->cl_cb_ident);
246}
247
248static void pnfs_init_server(struct nfs_server *server)
249{
250 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
251}
252
253#else
254static void nfs4_shutdown_client(struct nfs_client *clp)
255{
256}
257
258void nfs_cleanup_cb_ident_idr(void)
259{
260}
261
262static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
263{
264}
265
266static void pnfs_init_server(struct nfs_server *server)
267{
268}
269
270#endif /* CONFIG_NFS_V4 */
271
272/*
273 * Destroy a shared client record
274 */
275static void nfs_free_client(struct nfs_client *clp)
276{
277 dprintk("--> nfs_free_client(%u)\n", clp->rpc_ops->version);
278
279 nfs4_shutdown_client(clp);
280
281 nfs_fscache_release_client_cookie(clp);
282
283 /* -EIO all pending I/O */
284 if (!IS_ERR(clp->cl_rpcclient))
285 rpc_shutdown_client(clp->cl_rpcclient);
286
287 if (clp->cl_machine_cred != NULL)
288 put_rpccred(clp->cl_machine_cred);
289
290 nfs4_deviceid_purge_client(clp);
291
292 kfree(clp->cl_hostname);
293 kfree(clp->server_scope);
294 kfree(clp);
295
296 dprintk("<-- nfs_free_client()\n");
297}
298
299/*
300 * Release a reference to a shared client record
301 */
302void nfs_put_client(struct nfs_client *clp)
303{
304 if (!clp)
305 return;
306
307 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
308
309 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
310 list_del(&clp->cl_share_link);
311 nfs_cb_idr_remove_locked(clp);
312 spin_unlock(&nfs_client_lock);
313
314 BUG_ON(!list_empty(&clp->cl_superblocks));
315
316 nfs_free_client(clp);
317 }
318}
319EXPORT_SYMBOL_GPL(nfs_put_client);
320
321#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
322/*
323 * Test if two ip6 socket addresses refer to the same socket by
324 * comparing relevant fields. The padding bytes specifically, are not
325 * compared. sin6_flowinfo is not compared because it only affects QoS
326 * and sin6_scope_id is only compared if the address is "link local"
327 * because "link local" addresses need only be unique to a specific
328 * link. Conversely, ordinary unicast addresses might have different
329 * sin6_scope_id.
330 *
331 * The caller should ensure both socket addresses are AF_INET6.
332 */
333static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
334 const struct sockaddr *sa2)
335{
336 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
337 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
338
339 if (ipv6_addr_scope(&sin1->sin6_addr) == IPV6_ADDR_SCOPE_LINKLOCAL &&
340 sin1->sin6_scope_id != sin2->sin6_scope_id)
341 return 0;
342
343 return ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr);
344}
345#else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
346static int nfs_sockaddr_match_ipaddr6(const struct sockaddr *sa1,
347 const struct sockaddr *sa2)
348{
349 return 0;
350}
351#endif
352
353/*
354 * Test if two ip4 socket addresses refer to the same socket, by
355 * comparing relevant fields. The padding bytes specifically, are
356 * not compared.
357 *
358 * The caller should ensure both socket addresses are AF_INET.
359 */
360static int nfs_sockaddr_match_ipaddr4(const struct sockaddr *sa1,
361 const struct sockaddr *sa2)
362{
363 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
364 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
365
366 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
367}
368
369static int nfs_sockaddr_cmp_ip6(const struct sockaddr *sa1,
370 const struct sockaddr *sa2)
371{
372 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sa1;
373 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sa2;
374
375 return nfs_sockaddr_match_ipaddr6(sa1, sa2) &&
376 (sin1->sin6_port == sin2->sin6_port);
377}
378
379static int nfs_sockaddr_cmp_ip4(const struct sockaddr *sa1,
380 const struct sockaddr *sa2)
381{
382 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sa1;
383 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sa2;
384
385 return nfs_sockaddr_match_ipaddr4(sa1, sa2) &&
386 (sin1->sin_port == sin2->sin_port);
387}
388
389/*
390 * Test if two socket addresses represent the same actual socket,
391 * by comparing (only) relevant fields, excluding the port number.
392 */
393static int nfs_sockaddr_match_ipaddr(const struct sockaddr *sa1,
394 const struct sockaddr *sa2)
395{
396 if (sa1->sa_family != sa2->sa_family)
397 return 0;
398
399 switch (sa1->sa_family) {
400 case AF_INET:
401 return nfs_sockaddr_match_ipaddr4(sa1, sa2);
402 case AF_INET6:
403 return nfs_sockaddr_match_ipaddr6(sa1, sa2);
404 }
405 return 0;
406}
407
408/*
409 * Test if two socket addresses represent the same actual socket,
410 * by comparing (only) relevant fields, including the port number.
411 */
412static int nfs_sockaddr_cmp(const struct sockaddr *sa1,
413 const struct sockaddr *sa2)
414{
415 if (sa1->sa_family != sa2->sa_family)
416 return 0;
417
418 switch (sa1->sa_family) {
419 case AF_INET:
420 return nfs_sockaddr_cmp_ip4(sa1, sa2);
421 case AF_INET6:
422 return nfs_sockaddr_cmp_ip6(sa1, sa2);
423 }
424 return 0;
425}
426
427/* Common match routine for v4.0 and v4.1 callback services */
428bool
429nfs4_cb_match_client(const struct sockaddr *addr, struct nfs_client *clp,
430 u32 minorversion)
431{
432 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
433
434 /* Don't match clients that failed to initialise */
435 if (!(clp->cl_cons_state == NFS_CS_READY ||
436 clp->cl_cons_state == NFS_CS_SESSION_INITING))
437 return false;
438
439 /* Match the version and minorversion */
440 if (clp->rpc_ops->version != 4 ||
441 clp->cl_minorversion != minorversion)
442 return false;
443
444 /* Match only the IP address, not the port number */
445 if (!nfs_sockaddr_match_ipaddr(addr, clap))
446 return false;
447
448 return true;
449}
450
451/*
452 * Find an nfs_client on the list that matches the initialisation data
453 * that is supplied.
454 */
455static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
456{
457 struct nfs_client *clp;
458 const struct sockaddr *sap = data->addr;
459
460 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
461 const struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
462 /* Don't match clients that failed to initialise properly */
463 if (clp->cl_cons_state < 0)
464 continue;
465
466 /* Different NFS versions cannot share the same nfs_client */
467 if (clp->rpc_ops != data->rpc_ops)
468 continue;
469
470 if (clp->cl_proto != data->proto)
471 continue;
472 /* Match nfsv4 minorversion */
473 if (clp->cl_minorversion != data->minorversion)
474 continue;
475 /* Match the full socket address */
476 if (!nfs_sockaddr_cmp(sap, clap))
477 continue;
478
479 atomic_inc(&clp->cl_count);
480 return clp;
481 }
482 return NULL;
483}
484
485/*
486 * Look up a client by IP address and protocol version
487 * - creates a new record if one doesn't yet exist
488 */
489static struct nfs_client *
490nfs_get_client(const struct nfs_client_initdata *cl_init,
491 const struct rpc_timeout *timeparms,
492 const char *ip_addr,
493 rpc_authflavor_t authflavour,
494 int noresvport)
495{
496 struct nfs_client *clp, *new = NULL;
497 int error;
498
499 dprintk("--> nfs_get_client(%s,v%u)\n",
500 cl_init->hostname ?: "", cl_init->rpc_ops->version);
501
502 /* see if the client already exists */
503 do {
504 spin_lock(&nfs_client_lock);
505
506 clp = nfs_match_client(cl_init);
507 if (clp)
508 goto found_client;
509 if (new)
510 goto install_client;
511
512 spin_unlock(&nfs_client_lock);
513
514 new = nfs_alloc_client(cl_init);
515 } while (!IS_ERR(new));
516
517 dprintk("--> nfs_get_client() = %ld [failed]\n", PTR_ERR(new));
518 return new;
519
520 /* install a new client and return with it unready */
521install_client:
522 clp = new;
523 list_add(&clp->cl_share_link, &nfs_client_list);
524 spin_unlock(&nfs_client_lock);
525
526 error = cl_init->rpc_ops->init_client(clp, timeparms, ip_addr,
527 authflavour, noresvport);
528 if (error < 0) {
529 nfs_put_client(clp);
530 return ERR_PTR(error);
531 }
532 dprintk("--> nfs_get_client() = %p [new]\n", clp);
533 return clp;
534
535 /* found an existing client
536 * - make sure it's ready before returning
537 */
538found_client:
539 spin_unlock(&nfs_client_lock);
540
541 if (new)
542 nfs_free_client(new);
543
544 error = wait_event_killable(nfs_client_active_wq,
545 clp->cl_cons_state < NFS_CS_INITING);
546 if (error < 0) {
547 nfs_put_client(clp);
548 return ERR_PTR(-ERESTARTSYS);
549 }
550
551 if (clp->cl_cons_state < NFS_CS_READY) {
552 error = clp->cl_cons_state;
553 nfs_put_client(clp);
554 return ERR_PTR(error);
555 }
556
557 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
558
559 dprintk("--> nfs_get_client() = %p [share]\n", clp);
560 return clp;
561}
562
563/*
564 * Mark a server as ready or failed
565 */
566void nfs_mark_client_ready(struct nfs_client *clp, int state)
567{
568 clp->cl_cons_state = state;
569 wake_up_all(&nfs_client_active_wq);
570}
571
572/*
573 * With sessions, the client is not marked ready until after a
574 * successful EXCHANGE_ID and CREATE_SESSION.
575 *
576 * Map errors cl_cons_state errors to EPROTONOSUPPORT to indicate
577 * other versions of NFS can be tried.
578 */
579int nfs4_check_client_ready(struct nfs_client *clp)
580{
581 if (!nfs4_has_session(clp))
582 return 0;
583 if (clp->cl_cons_state < NFS_CS_READY)
584 return -EPROTONOSUPPORT;
585 return 0;
586}
587
588/*
589 * Initialise the timeout values for a connection
590 */
591static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
592 unsigned int timeo, unsigned int retrans)
593{
594 to->to_initval = timeo * HZ / 10;
595 to->to_retries = retrans;
596
597 switch (proto) {
598 case XPRT_TRANSPORT_TCP:
599 case XPRT_TRANSPORT_RDMA:
600 if (to->to_retries == 0)
601 to->to_retries = NFS_DEF_TCP_RETRANS;
602 if (to->to_initval == 0)
603 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
604 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
605 to->to_initval = NFS_MAX_TCP_TIMEOUT;
606 to->to_increment = to->to_initval;
607 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
608 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
609 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
610 if (to->to_maxval < to->to_initval)
611 to->to_maxval = to->to_initval;
612 to->to_exponential = 0;
613 break;
614 case XPRT_TRANSPORT_UDP:
615 if (to->to_retries == 0)
616 to->to_retries = NFS_DEF_UDP_RETRANS;
617 if (!to->to_initval)
618 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
619 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
620 to->to_initval = NFS_MAX_UDP_TIMEOUT;
621 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
622 to->to_exponential = 1;
623 break;
624 default:
625 BUG();
626 }
627}
628
629/*
630 * Create an RPC client handle
631 */
632static int nfs_create_rpc_client(struct nfs_client *clp,
633 const struct rpc_timeout *timeparms,
634 rpc_authflavor_t flavor,
635 int discrtry, int noresvport)
636{
637 struct rpc_clnt *clnt = NULL;
638 struct rpc_create_args args = {
639 .net = &init_net,
640 .protocol = clp->cl_proto,
641 .address = (struct sockaddr *)&clp->cl_addr,
642 .addrsize = clp->cl_addrlen,
643 .timeout = timeparms,
644 .servername = clp->cl_hostname,
645 .program = &nfs_program,
646 .version = clp->rpc_ops->version,
647 .authflavor = flavor,
648 };
649
650 if (discrtry)
651 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
652 if (noresvport)
653 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
654
655 if (!IS_ERR(clp->cl_rpcclient))
656 return 0;
657
658 clnt = rpc_create(&args);
659 if (IS_ERR(clnt)) {
660 dprintk("%s: cannot create RPC client. Error = %ld\n",
661 __func__, PTR_ERR(clnt));
662 return PTR_ERR(clnt);
663 }
664
665 clp->cl_rpcclient = clnt;
666 return 0;
667}
668
669/*
670 * Version 2 or 3 client destruction
671 */
672static void nfs_destroy_server(struct nfs_server *server)
673{
674 if (!(server->flags & NFS_MOUNT_LOCAL_FLOCK) ||
675 !(server->flags & NFS_MOUNT_LOCAL_FCNTL))
676 nlmclnt_done(server->nlm_host);
677}
678
679/*
680 * Version 2 or 3 lockd setup
681 */
682static int nfs_start_lockd(struct nfs_server *server)
683{
684 struct nlm_host *host;
685 struct nfs_client *clp = server->nfs_client;
686 struct nlmclnt_initdata nlm_init = {
687 .hostname = clp->cl_hostname,
688 .address = (struct sockaddr *)&clp->cl_addr,
689 .addrlen = clp->cl_addrlen,
690 .nfs_version = clp->rpc_ops->version,
691 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
692 1 : 0,
693 };
694
695 if (nlm_init.nfs_version > 3)
696 return 0;
697 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
698 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
699 return 0;
700
701 switch (clp->cl_proto) {
702 default:
703 nlm_init.protocol = IPPROTO_TCP;
704 break;
705 case XPRT_TRANSPORT_UDP:
706 nlm_init.protocol = IPPROTO_UDP;
707 }
708
709 host = nlmclnt_init(&nlm_init);
710 if (IS_ERR(host))
711 return PTR_ERR(host);
712
713 server->nlm_host = host;
714 server->destroy = nfs_destroy_server;
715 return 0;
716}
717
718/*
719 * Initialise an NFSv3 ACL client connection
720 */
721#ifdef CONFIG_NFS_V3_ACL
722static void nfs_init_server_aclclient(struct nfs_server *server)
723{
724 if (server->nfs_client->rpc_ops->version != 3)
725 goto out_noacl;
726 if (server->flags & NFS_MOUNT_NOACL)
727 goto out_noacl;
728
729 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
730 if (IS_ERR(server->client_acl))
731 goto out_noacl;
732
733 /* No errors! Assume that Sun nfsacls are supported */
734 server->caps |= NFS_CAP_ACLS;
735 return;
736
737out_noacl:
738 server->caps &= ~NFS_CAP_ACLS;
739}
740#else
741static inline void nfs_init_server_aclclient(struct nfs_server *server)
742{
743 server->flags &= ~NFS_MOUNT_NOACL;
744 server->caps &= ~NFS_CAP_ACLS;
745}
746#endif
747
748/*
749 * Create a general RPC client
750 */
751static int nfs_init_server_rpcclient(struct nfs_server *server,
752 const struct rpc_timeout *timeo,
753 rpc_authflavor_t pseudoflavour)
754{
755 struct nfs_client *clp = server->nfs_client;
756
757 server->client = rpc_clone_client(clp->cl_rpcclient);
758 if (IS_ERR(server->client)) {
759 dprintk("%s: couldn't create rpc_client!\n", __func__);
760 return PTR_ERR(server->client);
761 }
762
763 memcpy(&server->client->cl_timeout_default,
764 timeo,
765 sizeof(server->client->cl_timeout_default));
766 server->client->cl_timeout = &server->client->cl_timeout_default;
767
768 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
769 struct rpc_auth *auth;
770
771 auth = rpcauth_create(pseudoflavour, server->client);
772 if (IS_ERR(auth)) {
773 dprintk("%s: couldn't create credcache!\n", __func__);
774 return PTR_ERR(auth);
775 }
776 }
777 server->client->cl_softrtry = 0;
778 if (server->flags & NFS_MOUNT_SOFT)
779 server->client->cl_softrtry = 1;
780
781 return 0;
782}
783
784/*
785 * Initialise an NFS2 or NFS3 client
786 */
787int nfs_init_client(struct nfs_client *clp, const struct rpc_timeout *timeparms,
788 const char *ip_addr, rpc_authflavor_t authflavour,
789 int noresvport)
790{
791 int error;
792
793 if (clp->cl_cons_state == NFS_CS_READY) {
794 /* the client is already initialised */
795 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
796 return 0;
797 }
798
799 /*
800 * Create a client RPC handle for doing FSSTAT with UNIX auth only
801 * - RFC 2623, sec 2.3.2
802 */
803 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX,
804 0, noresvport);
805 if (error < 0)
806 goto error;
807 nfs_mark_client_ready(clp, NFS_CS_READY);
808 return 0;
809
810error:
811 nfs_mark_client_ready(clp, error);
812 dprintk("<-- nfs_init_client() = xerror %d\n", error);
813 return error;
814}
815
816/*
817 * Create a version 2 or 3 client
818 */
819static int nfs_init_server(struct nfs_server *server,
820 const struct nfs_parsed_mount_data *data)
821{
822 struct nfs_client_initdata cl_init = {
823 .hostname = data->nfs_server.hostname,
824 .addr = (const struct sockaddr *)&data->nfs_server.address,
825 .addrlen = data->nfs_server.addrlen,
826 .rpc_ops = &nfs_v2_clientops,
827 .proto = data->nfs_server.protocol,
828 };
829 struct rpc_timeout timeparms;
830 struct nfs_client *clp;
831 int error;
832
833 dprintk("--> nfs_init_server()\n");
834
835#ifdef CONFIG_NFS_V3
836 if (data->version == 3)
837 cl_init.rpc_ops = &nfs_v3_clientops;
838#endif
839
840 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
841 data->timeo, data->retrans);
842
843 /* Allocate or find a client reference we can use */
844 clp = nfs_get_client(&cl_init, &timeparms, NULL, RPC_AUTH_UNIX,
845 data->flags & NFS_MOUNT_NORESVPORT);
846 if (IS_ERR(clp)) {
847 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
848 return PTR_ERR(clp);
849 }
850
851 server->nfs_client = clp;
852
853 /* Initialise the client representation from the mount data */
854 server->flags = data->flags;
855 server->options = data->options;
856 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
857 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
858 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
859
860 if (data->rsize)
861 server->rsize = nfs_block_size(data->rsize, NULL);
862 if (data->wsize)
863 server->wsize = nfs_block_size(data->wsize, NULL);
864
865 server->acregmin = data->acregmin * HZ;
866 server->acregmax = data->acregmax * HZ;
867 server->acdirmin = data->acdirmin * HZ;
868 server->acdirmax = data->acdirmax * HZ;
869
870 /* Start lockd here, before we might error out */
871 error = nfs_start_lockd(server);
872 if (error < 0)
873 goto error;
874
875 server->port = data->nfs_server.port;
876
877 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
878 if (error < 0)
879 goto error;
880
881 /* Preserve the values of mount_server-related mount options */
882 if (data->mount_server.addrlen) {
883 memcpy(&server->mountd_address, &data->mount_server.address,
884 data->mount_server.addrlen);
885 server->mountd_addrlen = data->mount_server.addrlen;
886 }
887 server->mountd_version = data->mount_server.version;
888 server->mountd_port = data->mount_server.port;
889 server->mountd_protocol = data->mount_server.protocol;
890
891 server->namelen = data->namlen;
892 /* Create a client RPC handle for the NFSv3 ACL management interface */
893 nfs_init_server_aclclient(server);
894 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
895 return 0;
896
897error:
898 server->nfs_client = NULL;
899 nfs_put_client(clp);
900 dprintk("<-- nfs_init_server() = xerror %d\n", error);
901 return error;
902}
903
904/*
905 * Load up the server record from information gained in an fsinfo record
906 */
907static void nfs_server_set_fsinfo(struct nfs_server *server,
908 struct nfs_fh *mntfh,
909 struct nfs_fsinfo *fsinfo)
910{
911 unsigned long max_rpc_payload;
912
913 /* Work out a lot of parameters */
914 if (server->rsize == 0)
915 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
916 if (server->wsize == 0)
917 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
918
919 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
920 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
921 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
922 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
923
924 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
925 if (server->rsize > max_rpc_payload)
926 server->rsize = max_rpc_payload;
927 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
928 server->rsize = NFS_MAX_FILE_IO_SIZE;
929 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
930
931 server->backing_dev_info.name = "nfs";
932 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
933
934 if (server->wsize > max_rpc_payload)
935 server->wsize = max_rpc_payload;
936 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
937 server->wsize = NFS_MAX_FILE_IO_SIZE;
938 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
939 server->pnfs_blksize = fsinfo->blksize;
940 set_pnfs_layoutdriver(server, mntfh, fsinfo->layouttype);
941
942 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
943
944 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
945 if (server->dtsize > PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES)
946 server->dtsize = PAGE_CACHE_SIZE * NFS_MAX_READDIR_PAGES;
947 if (server->dtsize > server->rsize)
948 server->dtsize = server->rsize;
949
950 if (server->flags & NFS_MOUNT_NOAC) {
951 server->acregmin = server->acregmax = 0;
952 server->acdirmin = server->acdirmax = 0;
953 }
954
955 server->maxfilesize = fsinfo->maxfilesize;
956
957 server->time_delta = fsinfo->time_delta;
958
959 /* We're airborne Set socket buffersize */
960 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
961}
962
963/*
964 * Probe filesystem information, including the FSID on v2/v3
965 */
966static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
967{
968 struct nfs_fsinfo fsinfo;
969 struct nfs_client *clp = server->nfs_client;
970 int error;
971
972 dprintk("--> nfs_probe_fsinfo()\n");
973
974 if (clp->rpc_ops->set_capabilities != NULL) {
975 error = clp->rpc_ops->set_capabilities(server, mntfh);
976 if (error < 0)
977 goto out_error;
978 }
979
980 fsinfo.fattr = fattr;
981 fsinfo.layouttype = 0;
982 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
983 if (error < 0)
984 goto out_error;
985
986 nfs_server_set_fsinfo(server, mntfh, &fsinfo);
987
988 /* Get some general file system info */
989 if (server->namelen == 0) {
990 struct nfs_pathconf pathinfo;
991
992 pathinfo.fattr = fattr;
993 nfs_fattr_init(fattr);
994
995 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
996 server->namelen = pathinfo.max_namelen;
997 }
998
999 dprintk("<-- nfs_probe_fsinfo() = 0\n");
1000 return 0;
1001
1002out_error:
1003 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
1004 return error;
1005}
1006
1007/*
1008 * Copy useful information when duplicating a server record
1009 */
1010static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
1011{
1012 target->flags = source->flags;
1013 target->rsize = source->rsize;
1014 target->wsize = source->wsize;
1015 target->acregmin = source->acregmin;
1016 target->acregmax = source->acregmax;
1017 target->acdirmin = source->acdirmin;
1018 target->acdirmax = source->acdirmax;
1019 target->caps = source->caps;
1020 target->options = source->options;
1021}
1022
1023static void nfs_server_insert_lists(struct nfs_server *server)
1024{
1025 struct nfs_client *clp = server->nfs_client;
1026
1027 spin_lock(&nfs_client_lock);
1028 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
1029 list_add_tail(&server->master_link, &nfs_volume_list);
1030 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
1031 spin_unlock(&nfs_client_lock);
1032
1033}
1034
1035static void nfs_server_remove_lists(struct nfs_server *server)
1036{
1037 struct nfs_client *clp = server->nfs_client;
1038
1039 spin_lock(&nfs_client_lock);
1040 list_del_rcu(&server->client_link);
1041 if (clp && list_empty(&clp->cl_superblocks))
1042 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
1043 list_del(&server->master_link);
1044 spin_unlock(&nfs_client_lock);
1045
1046 synchronize_rcu();
1047}
1048
1049/*
1050 * Allocate and initialise a server record
1051 */
1052static struct nfs_server *nfs_alloc_server(void)
1053{
1054 struct nfs_server *server;
1055
1056 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
1057 if (!server)
1058 return NULL;
1059
1060 server->client = server->client_acl = ERR_PTR(-EINVAL);
1061
1062 /* Zero out the NFS state stuff */
1063 INIT_LIST_HEAD(&server->client_link);
1064 INIT_LIST_HEAD(&server->master_link);
1065 INIT_LIST_HEAD(&server->delegations);
1066 INIT_LIST_HEAD(&server->layouts);
1067
1068 atomic_set(&server->active, 0);
1069
1070 server->io_stats = nfs_alloc_iostats();
1071 if (!server->io_stats) {
1072 kfree(server);
1073 return NULL;
1074 }
1075
1076 if (bdi_init(&server->backing_dev_info)) {
1077 nfs_free_iostats(server->io_stats);
1078 kfree(server);
1079 return NULL;
1080 }
1081
1082 pnfs_init_server(server);
1083
1084 return server;
1085}
1086
1087/*
1088 * Free up a server record
1089 */
1090void nfs_free_server(struct nfs_server *server)
1091{
1092 dprintk("--> nfs_free_server()\n");
1093
1094 nfs_server_remove_lists(server);
1095 unset_pnfs_layoutdriver(server);
1096
1097 if (server->destroy != NULL)
1098 server->destroy(server);
1099
1100 if (!IS_ERR(server->client_acl))
1101 rpc_shutdown_client(server->client_acl);
1102 if (!IS_ERR(server->client))
1103 rpc_shutdown_client(server->client);
1104
1105 nfs_put_client(server->nfs_client);
1106
1107 nfs_free_iostats(server->io_stats);
1108 bdi_destroy(&server->backing_dev_info);
1109 kfree(server);
1110 nfs_release_automount_timer();
1111 dprintk("<-- nfs_free_server()\n");
1112}
1113
1114/*
1115 * Create a version 2 or 3 volume record
1116 * - keyed on server and FSID
1117 */
1118struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
1119 struct nfs_fh *mntfh)
1120{
1121 struct nfs_server *server;
1122 struct nfs_fattr *fattr;
1123 int error;
1124
1125 server = nfs_alloc_server();
1126 if (!server)
1127 return ERR_PTR(-ENOMEM);
1128
1129 error = -ENOMEM;
1130 fattr = nfs_alloc_fattr();
1131 if (fattr == NULL)
1132 goto error;
1133
1134 /* Get a client representation */
1135 error = nfs_init_server(server, data);
1136 if (error < 0)
1137 goto error;
1138
1139 BUG_ON(!server->nfs_client);
1140 BUG_ON(!server->nfs_client->rpc_ops);
1141 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1142
1143 /* Probe the root fh to retrieve its FSID */
1144 error = nfs_probe_fsinfo(server, mntfh, fattr);
1145 if (error < 0)
1146 goto error;
1147 if (server->nfs_client->rpc_ops->version == 3) {
1148 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
1149 server->namelen = NFS3_MAXNAMLEN;
1150 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
1151 server->caps |= NFS_CAP_READDIRPLUS;
1152 } else {
1153 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
1154 server->namelen = NFS2_MAXNAMLEN;
1155 }
1156
1157 if (!(fattr->valid & NFS_ATTR_FATTR)) {
1158 error = server->nfs_client->rpc_ops->getattr(server, mntfh, fattr);
1159 if (error < 0) {
1160 dprintk("nfs_create_server: getattr error = %d\n", -error);
1161 goto error;
1162 }
1163 }
1164 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
1165
1166 dprintk("Server FSID: %llx:%llx\n",
1167 (unsigned long long) server->fsid.major,
1168 (unsigned long long) server->fsid.minor);
1169
1170 nfs_server_insert_lists(server);
1171 server->mount_time = jiffies;
1172 nfs_free_fattr(fattr);
1173 return server;
1174
1175error:
1176 nfs_free_fattr(fattr);
1177 nfs_free_server(server);
1178 return ERR_PTR(error);
1179}
1180
1181#ifdef CONFIG_NFS_V4
1182/*
1183 * NFSv4.0 callback thread helper
1184 *
1185 * Find a client by IP address, protocol version, and minorversion
1186 *
1187 * Called from the pg_authenticate method. The callback identifier
1188 * is not used as it has not been decoded.
1189 *
1190 * Returns NULL if no such client
1191 */
1192struct nfs_client *
1193nfs4_find_client_no_ident(const struct sockaddr *addr)
1194{
1195 struct nfs_client *clp;
1196
1197 spin_lock(&nfs_client_lock);
1198 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
1199 if (nfs4_cb_match_client(addr, clp, 0) == false)
1200 continue;
1201 atomic_inc(&clp->cl_count);
1202 spin_unlock(&nfs_client_lock);
1203 return clp;
1204 }
1205 spin_unlock(&nfs_client_lock);
1206 return NULL;
1207}
1208
1209/*
1210 * NFSv4.0 callback thread helper
1211 *
1212 * Find a client by callback identifier
1213 */
1214struct nfs_client *
1215nfs4_find_client_ident(int cb_ident)
1216{
1217 struct nfs_client *clp;
1218
1219 spin_lock(&nfs_client_lock);
1220 clp = idr_find(&cb_ident_idr, cb_ident);
1221 if (clp)
1222 atomic_inc(&clp->cl_count);
1223 spin_unlock(&nfs_client_lock);
1224 return clp;
1225}
1226
1227#if defined(CONFIG_NFS_V4_1)
1228/*
1229 * NFSv4.1 callback thread helper
1230 * For CB_COMPOUND calls, find a client by IP address, protocol version,
1231 * minorversion, and sessionID
1232 *
1233 * Returns NULL if no such client
1234 */
1235struct nfs_client *
1236nfs4_find_client_sessionid(const struct sockaddr *addr,
1237 struct nfs4_sessionid *sid)
1238{
1239 struct nfs_client *clp;
1240
1241 spin_lock(&nfs_client_lock);
1242 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
1243 if (nfs4_cb_match_client(addr, clp, 1) == false)
1244 continue;
1245
1246 if (!nfs4_has_session(clp))
1247 continue;
1248
1249 /* Match sessionid*/
1250 if (memcmp(clp->cl_session->sess_id.data,
1251 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
1252 continue;
1253
1254 atomic_inc(&clp->cl_count);
1255 spin_unlock(&nfs_client_lock);
1256 return clp;
1257 }
1258 spin_unlock(&nfs_client_lock);
1259 return NULL;
1260}
1261
1262#else /* CONFIG_NFS_V4_1 */
1263
1264struct nfs_client *
1265nfs4_find_client_sessionid(const struct sockaddr *addr,
1266 struct nfs4_sessionid *sid)
1267{
1268 return NULL;
1269}
1270#endif /* CONFIG_NFS_V4_1 */
1271
1272/*
1273 * Initialize the NFS4 callback service
1274 */
1275static int nfs4_init_callback(struct nfs_client *clp)
1276{
1277 int error;
1278
1279 if (clp->rpc_ops->version == 4) {
1280 if (nfs4_has_session(clp)) {
1281 error = xprt_setup_backchannel(
1282 clp->cl_rpcclient->cl_xprt,
1283 NFS41_BC_MIN_CALLBACKS);
1284 if (error < 0)
1285 return error;
1286 }
1287
1288 error = nfs_callback_up(clp->cl_mvops->minor_version,
1289 clp->cl_rpcclient->cl_xprt);
1290 if (error < 0) {
1291 dprintk("%s: failed to start callback. Error = %d\n",
1292 __func__, error);
1293 return error;
1294 }
1295 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
1296 }
1297 return 0;
1298}
1299
1300/*
1301 * Initialize the minor version specific parts of an NFS4 client record
1302 */
1303static int nfs4_init_client_minor_version(struct nfs_client *clp)
1304{
1305#if defined(CONFIG_NFS_V4_1)
1306 if (clp->cl_mvops->minor_version) {
1307 struct nfs4_session *session = NULL;
1308 /*
1309 * Create the session and mark it expired.
1310 * When a SEQUENCE operation encounters the expired session
1311 * it will do session recovery to initialize it.
1312 */
1313 session = nfs4_alloc_session(clp);
1314 if (!session)
1315 return -ENOMEM;
1316
1317 clp->cl_session = session;
1318 /*
1319 * The create session reply races with the server back
1320 * channel probe. Mark the client NFS_CS_SESSION_INITING
1321 * so that the client back channel can find the
1322 * nfs_client struct
1323 */
1324 clp->cl_cons_state = NFS_CS_SESSION_INITING;
1325 }
1326#endif /* CONFIG_NFS_V4_1 */
1327
1328 return nfs4_init_callback(clp);
1329}
1330
1331/*
1332 * Initialise an NFS4 client record
1333 */
1334int nfs4_init_client(struct nfs_client *clp,
1335 const struct rpc_timeout *timeparms,
1336 const char *ip_addr,
1337 rpc_authflavor_t authflavour,
1338 int noresvport)
1339{
1340 int error;
1341
1342 if (clp->cl_cons_state == NFS_CS_READY) {
1343 /* the client is initialised already */
1344 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
1345 return 0;
1346 }
1347
1348 /* Check NFS protocol revision and initialize RPC op vector */
1349 clp->rpc_ops = &nfs_v4_clientops;
1350
1351 error = nfs_create_rpc_client(clp, timeparms, authflavour,
1352 1, noresvport);
1353 if (error < 0)
1354 goto error;
1355 strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
1356
1357 error = nfs_idmap_new(clp);
1358 if (error < 0) {
1359 dprintk("%s: failed to create idmapper. Error = %d\n",
1360 __func__, error);
1361 goto error;
1362 }
1363 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
1364
1365 error = nfs4_init_client_minor_version(clp);
1366 if (error < 0)
1367 goto error;
1368
1369 if (!nfs4_has_session(clp))
1370 nfs_mark_client_ready(clp, NFS_CS_READY);
1371 return 0;
1372
1373error:
1374 nfs_mark_client_ready(clp, error);
1375 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
1376 return error;
1377}
1378
1379/*
1380 * Set up an NFS4 client
1381 */
1382static int nfs4_set_client(struct nfs_server *server,
1383 const char *hostname,
1384 const struct sockaddr *addr,
1385 const size_t addrlen,
1386 const char *ip_addr,
1387 rpc_authflavor_t authflavour,
1388 int proto, const struct rpc_timeout *timeparms,
1389 u32 minorversion)
1390{
1391 struct nfs_client_initdata cl_init = {
1392 .hostname = hostname,
1393 .addr = addr,
1394 .addrlen = addrlen,
1395 .rpc_ops = &nfs_v4_clientops,
1396 .proto = proto,
1397 .minorversion = minorversion,
1398 };
1399 struct nfs_client *clp;
1400 int error;
1401
1402 dprintk("--> nfs4_set_client()\n");
1403
1404 /* Allocate or find a client reference we can use */
1405 clp = nfs_get_client(&cl_init, timeparms, ip_addr, authflavour,
1406 server->flags & NFS_MOUNT_NORESVPORT);
1407 if (IS_ERR(clp)) {
1408 error = PTR_ERR(clp);
1409 goto error;
1410 }
1411
1412 /*
1413 * Query for the lease time on clientid setup or renewal
1414 *
1415 * Note that this will be set on nfs_clients that were created
1416 * only for the DS role and did not set this bit, but now will
1417 * serve a dual role.
1418 */
1419 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
1420
1421 server->nfs_client = clp;
1422 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
1423 return 0;
1424error:
1425 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
1426 return error;
1427}
1428
1429/*
1430 * Set up a pNFS Data Server client.
1431 *
1432 * Return any existing nfs_client that matches server address,port,version
1433 * and minorversion.
1434 *
1435 * For a new nfs_client, use a soft mount (default), a low retrans and a
1436 * low timeout interval so that if a connection is lost, we retry through
1437 * the MDS.
1438 */
1439struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
1440 const struct sockaddr *ds_addr,
1441 int ds_addrlen, int ds_proto)
1442{
1443 struct nfs_client_initdata cl_init = {
1444 .addr = ds_addr,
1445 .addrlen = ds_addrlen,
1446 .rpc_ops = &nfs_v4_clientops,
1447 .proto = ds_proto,
1448 .minorversion = mds_clp->cl_minorversion,
1449 };
1450 struct rpc_timeout ds_timeout = {
1451 .to_initval = 15 * HZ,
1452 .to_maxval = 15 * HZ,
1453 .to_retries = 1,
1454 .to_exponential = 1,
1455 };
1456 struct nfs_client *clp;
1457
1458 /*
1459 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
1460 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
1461 * (section 13.1 RFC 5661).
1462 */
1463 clp = nfs_get_client(&cl_init, &ds_timeout, mds_clp->cl_ipaddr,
1464 mds_clp->cl_rpcclient->cl_auth->au_flavor, 0);
1465
1466 dprintk("<-- %s %p\n", __func__, clp);
1467 return clp;
1468}
1469EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
1470
1471/*
1472 * Session has been established, and the client marked ready.
1473 * Set the mount rsize and wsize with negotiated fore channel
1474 * attributes which will be bound checked in nfs_server_set_fsinfo.
1475 */
1476static void nfs4_session_set_rwsize(struct nfs_server *server)
1477{
1478#ifdef CONFIG_NFS_V4_1
1479 struct nfs4_session *sess;
1480 u32 server_resp_sz;
1481 u32 server_rqst_sz;
1482
1483 if (!nfs4_has_session(server->nfs_client))
1484 return;
1485 sess = server->nfs_client->cl_session;
1486 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1487 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1488
1489 if (server->rsize > server_resp_sz)
1490 server->rsize = server_resp_sz;
1491 if (server->wsize > server_rqst_sz)
1492 server->wsize = server_rqst_sz;
1493#endif /* CONFIG_NFS_V4_1 */
1494}
1495
1496static int nfs4_server_common_setup(struct nfs_server *server,
1497 struct nfs_fh *mntfh)
1498{
1499 struct nfs_fattr *fattr;
1500 int error;
1501
1502 BUG_ON(!server->nfs_client);
1503 BUG_ON(!server->nfs_client->rpc_ops);
1504 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1505
1506 /* data servers support only a subset of NFSv4.1 */
1507 if (is_ds_only_client(server->nfs_client))
1508 return -EPROTONOSUPPORT;
1509
1510 fattr = nfs_alloc_fattr();
1511 if (fattr == NULL)
1512 return -ENOMEM;
1513
1514 /* We must ensure the session is initialised first */
1515 error = nfs4_init_session(server);
1516 if (error < 0)
1517 goto out;
1518
1519 /* Probe the root fh to retrieve its FSID and filehandle */
1520 error = nfs4_get_rootfh(server, mntfh);
1521 if (error < 0)
1522 goto out;
1523
1524 dprintk("Server FSID: %llx:%llx\n",
1525 (unsigned long long) server->fsid.major,
1526 (unsigned long long) server->fsid.minor);
1527 dprintk("Mount FH: %d\n", mntfh->size);
1528
1529 nfs4_session_set_rwsize(server);
1530
1531 error = nfs_probe_fsinfo(server, mntfh, fattr);
1532 if (error < 0)
1533 goto out;
1534
1535 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1536 server->namelen = NFS4_MAXNAMLEN;
1537
1538 nfs_server_insert_lists(server);
1539 server->mount_time = jiffies;
1540out:
1541 nfs_free_fattr(fattr);
1542 return error;
1543}
1544
1545/*
1546 * Create a version 4 volume record
1547 */
1548static int nfs4_init_server(struct nfs_server *server,
1549 const struct nfs_parsed_mount_data *data)
1550{
1551 struct rpc_timeout timeparms;
1552 int error;
1553
1554 dprintk("--> nfs4_init_server()\n");
1555
1556 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1557 data->timeo, data->retrans);
1558
1559 /* Initialise the client representation from the mount data */
1560 server->flags = data->flags;
1561 server->caps |= NFS_CAP_ATOMIC_OPEN|NFS_CAP_CHANGE_ATTR|NFS_CAP_POSIX_LOCK;
1562 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
1563 server->caps |= NFS_CAP_READDIRPLUS;
1564 server->options = data->options;
1565
1566 /* Get a client record */
1567 error = nfs4_set_client(server,
1568 data->nfs_server.hostname,
1569 (const struct sockaddr *)&data->nfs_server.address,
1570 data->nfs_server.addrlen,
1571 data->client_address,
1572 data->auth_flavors[0],
1573 data->nfs_server.protocol,
1574 &timeparms,
1575 data->minorversion);
1576 if (error < 0)
1577 goto error;
1578
1579 /*
1580 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1581 * authentication.
1582 */
1583 if (nfs4_disable_idmapping && data->auth_flavors[0] == RPC_AUTH_UNIX)
1584 server->caps |= NFS_CAP_UIDGID_NOMAP;
1585
1586 if (data->rsize)
1587 server->rsize = nfs_block_size(data->rsize, NULL);
1588 if (data->wsize)
1589 server->wsize = nfs_block_size(data->wsize, NULL);
1590
1591 server->acregmin = data->acregmin * HZ;
1592 server->acregmax = data->acregmax * HZ;
1593 server->acdirmin = data->acdirmin * HZ;
1594 server->acdirmax = data->acdirmax * HZ;
1595
1596 server->port = data->nfs_server.port;
1597
1598 error = nfs_init_server_rpcclient(server, &timeparms, data->auth_flavors[0]);
1599
1600error:
1601 /* Done */
1602 dprintk("<-- nfs4_init_server() = %d\n", error);
1603 return error;
1604}
1605
1606/*
1607 * Create a version 4 volume record
1608 * - keyed on server and FSID
1609 */
1610struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1611 struct nfs_fh *mntfh)
1612{
1613 struct nfs_server *server;
1614 int error;
1615
1616 dprintk("--> nfs4_create_server()\n");
1617
1618 server = nfs_alloc_server();
1619 if (!server)
1620 return ERR_PTR(-ENOMEM);
1621
1622 /* set up the general RPC client */
1623 error = nfs4_init_server(server, data);
1624 if (error < 0)
1625 goto error;
1626
1627 error = nfs4_server_common_setup(server, mntfh);
1628 if (error < 0)
1629 goto error;
1630
1631 dprintk("<-- nfs4_create_server() = %p\n", server);
1632 return server;
1633
1634error:
1635 nfs_free_server(server);
1636 dprintk("<-- nfs4_create_server() = error %d\n", error);
1637 return ERR_PTR(error);
1638}
1639
1640/*
1641 * Create an NFS4 referral server record
1642 */
1643struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1644 struct nfs_fh *mntfh)
1645{
1646 struct nfs_client *parent_client;
1647 struct nfs_server *server, *parent_server;
1648 int error;
1649
1650 dprintk("--> nfs4_create_referral_server()\n");
1651
1652 server = nfs_alloc_server();
1653 if (!server)
1654 return ERR_PTR(-ENOMEM);
1655
1656 parent_server = NFS_SB(data->sb);
1657 parent_client = parent_server->nfs_client;
1658
1659 /* Initialise the client representation from the parent server */
1660 nfs_server_copy_userdata(server, parent_server);
1661 server->caps |= NFS_CAP_ATOMIC_OPEN|NFS_CAP_CHANGE_ATTR;
1662
1663 /* Get a client representation.
1664 * Note: NFSv4 always uses TCP, */
1665 error = nfs4_set_client(server, data->hostname,
1666 data->addr,
1667 data->addrlen,
1668 parent_client->cl_ipaddr,
1669 data->authflavor,
1670 parent_server->client->cl_xprt->prot,
1671 parent_server->client->cl_timeout,
1672 parent_client->cl_mvops->minor_version);
1673 if (error < 0)
1674 goto error;
1675
1676 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1677 if (error < 0)
1678 goto error;
1679
1680 error = nfs4_server_common_setup(server, mntfh);
1681 if (error < 0)
1682 goto error;
1683
1684 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1685 return server;
1686
1687error:
1688 nfs_free_server(server);
1689 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1690 return ERR_PTR(error);
1691}
1692
1693#endif /* CONFIG_NFS_V4 */
1694
1695/*
1696 * Clone an NFS2, NFS3 or NFS4 server record
1697 */
1698struct nfs_server *nfs_clone_server(struct nfs_server *source,
1699 struct nfs_fh *fh,
1700 struct nfs_fattr *fattr)
1701{
1702 struct nfs_server *server;
1703 struct nfs_fattr *fattr_fsinfo;
1704 int error;
1705
1706 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1707 (unsigned long long) fattr->fsid.major,
1708 (unsigned long long) fattr->fsid.minor);
1709
1710 server = nfs_alloc_server();
1711 if (!server)
1712 return ERR_PTR(-ENOMEM);
1713
1714 error = -ENOMEM;
1715 fattr_fsinfo = nfs_alloc_fattr();
1716 if (fattr_fsinfo == NULL)
1717 goto out_free_server;
1718
1719 /* Copy data from the source */
1720 server->nfs_client = source->nfs_client;
1721 atomic_inc(&server->nfs_client->cl_count);
1722 nfs_server_copy_userdata(server, source);
1723
1724 server->fsid = fattr->fsid;
1725
1726 error = nfs_init_server_rpcclient(server,
1727 source->client->cl_timeout,
1728 source->client->cl_auth->au_flavor);
1729 if (error < 0)
1730 goto out_free_server;
1731 if (!IS_ERR(source->client_acl))
1732 nfs_init_server_aclclient(server);
1733
1734 /* probe the filesystem info for this server filesystem */
1735 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1736 if (error < 0)
1737 goto out_free_server;
1738
1739 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1740 server->namelen = NFS4_MAXNAMLEN;
1741
1742 dprintk("Cloned FSID: %llx:%llx\n",
1743 (unsigned long long) server->fsid.major,
1744 (unsigned long long) server->fsid.minor);
1745
1746 error = nfs_start_lockd(server);
1747 if (error < 0)
1748 goto out_free_server;
1749
1750 nfs_server_insert_lists(server);
1751 server->mount_time = jiffies;
1752
1753 nfs_free_fattr(fattr_fsinfo);
1754 dprintk("<-- nfs_clone_server() = %p\n", server);
1755 return server;
1756
1757out_free_server:
1758 nfs_free_fattr(fattr_fsinfo);
1759 nfs_free_server(server);
1760 dprintk("<-- nfs_clone_server() = error %d\n", error);
1761 return ERR_PTR(error);
1762}
1763
1764#ifdef CONFIG_PROC_FS
1765static struct proc_dir_entry *proc_fs_nfs;
1766
1767static int nfs_server_list_open(struct inode *inode, struct file *file);
1768static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1769static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1770static void nfs_server_list_stop(struct seq_file *p, void *v);
1771static int nfs_server_list_show(struct seq_file *m, void *v);
1772
1773static const struct seq_operations nfs_server_list_ops = {
1774 .start = nfs_server_list_start,
1775 .next = nfs_server_list_next,
1776 .stop = nfs_server_list_stop,
1777 .show = nfs_server_list_show,
1778};
1779
1780static const struct file_operations nfs_server_list_fops = {
1781 .open = nfs_server_list_open,
1782 .read = seq_read,
1783 .llseek = seq_lseek,
1784 .release = seq_release,
1785 .owner = THIS_MODULE,
1786};
1787
1788static int nfs_volume_list_open(struct inode *inode, struct file *file);
1789static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1790static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1791static void nfs_volume_list_stop(struct seq_file *p, void *v);
1792static int nfs_volume_list_show(struct seq_file *m, void *v);
1793
1794static const struct seq_operations nfs_volume_list_ops = {
1795 .start = nfs_volume_list_start,
1796 .next = nfs_volume_list_next,
1797 .stop = nfs_volume_list_stop,
1798 .show = nfs_volume_list_show,
1799};
1800
1801static const struct file_operations nfs_volume_list_fops = {
1802 .open = nfs_volume_list_open,
1803 .read = seq_read,
1804 .llseek = seq_lseek,
1805 .release = seq_release,
1806 .owner = THIS_MODULE,
1807};
1808
1809/*
1810 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1811 * we're dealing
1812 */
1813static int nfs_server_list_open(struct inode *inode, struct file *file)
1814{
1815 struct seq_file *m;
1816 int ret;
1817
1818 ret = seq_open(file, &nfs_server_list_ops);
1819 if (ret < 0)
1820 return ret;
1821
1822 m = file->private_data;
1823 m->private = PDE(inode)->data;
1824
1825 return 0;
1826}
1827
1828/*
1829 * set up the iterator to start reading from the server list and return the first item
1830 */
1831static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1832{
1833 /* lock the list against modification */
1834 spin_lock(&nfs_client_lock);
1835 return seq_list_start_head(&nfs_client_list, *_pos);
1836}
1837
1838/*
1839 * move to next server
1840 */
1841static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1842{
1843 return seq_list_next(v, &nfs_client_list, pos);
1844}
1845
1846/*
1847 * clean up after reading from the transports list
1848 */
1849static void nfs_server_list_stop(struct seq_file *p, void *v)
1850{
1851 spin_unlock(&nfs_client_lock);
1852}
1853
1854/*
1855 * display a header line followed by a load of call lines
1856 */
1857static int nfs_server_list_show(struct seq_file *m, void *v)
1858{
1859 struct nfs_client *clp;
1860
1861 /* display header on line 1 */
1862 if (v == &nfs_client_list) {
1863 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1864 return 0;
1865 }
1866
1867 /* display one transport per line on subsequent lines */
1868 clp = list_entry(v, struct nfs_client, cl_share_link);
1869
1870 seq_printf(m, "v%u %s %s %3d %s\n",
1871 clp->rpc_ops->version,
1872 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1873 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1874 atomic_read(&clp->cl_count),
1875 clp->cl_hostname);
1876
1877 return 0;
1878}
1879
1880/*
1881 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1882 */
1883static int nfs_volume_list_open(struct inode *inode, struct file *file)
1884{
1885 struct seq_file *m;
1886 int ret;
1887
1888 ret = seq_open(file, &nfs_volume_list_ops);
1889 if (ret < 0)
1890 return ret;
1891
1892 m = file->private_data;
1893 m->private = PDE(inode)->data;
1894
1895 return 0;
1896}
1897
1898/*
1899 * set up the iterator to start reading from the volume list and return the first item
1900 */
1901static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1902{
1903 /* lock the list against modification */
1904 spin_lock(&nfs_client_lock);
1905 return seq_list_start_head(&nfs_volume_list, *_pos);
1906}
1907
1908/*
1909 * move to next volume
1910 */
1911static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1912{
1913 return seq_list_next(v, &nfs_volume_list, pos);
1914}
1915
1916/*
1917 * clean up after reading from the transports list
1918 */
1919static void nfs_volume_list_stop(struct seq_file *p, void *v)
1920{
1921 spin_unlock(&nfs_client_lock);
1922}
1923
1924/*
1925 * display a header line followed by a load of call lines
1926 */
1927static int nfs_volume_list_show(struct seq_file *m, void *v)
1928{
1929 struct nfs_server *server;
1930 struct nfs_client *clp;
1931 char dev[8], fsid[17];
1932
1933 /* display header on line 1 */
1934 if (v == &nfs_volume_list) {
1935 seq_puts(m, "NV SERVER PORT DEV FSID FSC\n");
1936 return 0;
1937 }
1938 /* display one transport per line on subsequent lines */
1939 server = list_entry(v, struct nfs_server, master_link);
1940 clp = server->nfs_client;
1941
1942 snprintf(dev, 8, "%u:%u",
1943 MAJOR(server->s_dev), MINOR(server->s_dev));
1944
1945 snprintf(fsid, 17, "%llx:%llx",
1946 (unsigned long long) server->fsid.major,
1947 (unsigned long long) server->fsid.minor);
1948
1949 seq_printf(m, "v%u %s %s %-7s %-17s %s\n",
1950 clp->rpc_ops->version,
1951 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1952 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1953 dev,
1954 fsid,
1955 nfs_server_fscache_state(server));
1956
1957 return 0;
1958}
1959
1960/*
1961 * initialise the /proc/fs/nfsfs/ directory
1962 */
1963int __init nfs_fs_proc_init(void)
1964{
1965 struct proc_dir_entry *p;
1966
1967 proc_fs_nfs = proc_mkdir("fs/nfsfs", NULL);
1968 if (!proc_fs_nfs)
1969 goto error_0;
1970
1971 /* a file of servers with which we're dealing */
1972 p = proc_create("servers", S_IFREG|S_IRUGO,
1973 proc_fs_nfs, &nfs_server_list_fops);
1974 if (!p)
1975 goto error_1;
1976
1977 /* a file of volumes that we have mounted */
1978 p = proc_create("volumes", S_IFREG|S_IRUGO,
1979 proc_fs_nfs, &nfs_volume_list_fops);
1980 if (!p)
1981 goto error_2;
1982 return 0;
1983
1984error_2:
1985 remove_proc_entry("servers", proc_fs_nfs);
1986error_1:
1987 remove_proc_entry("fs/nfsfs", NULL);
1988error_0:
1989 return -ENOMEM;
1990}
1991
1992/*
1993 * clean up the /proc/fs/nfsfs/ directory
1994 */
1995void nfs_fs_proc_exit(void)
1996{
1997 remove_proc_entry("volumes", proc_fs_nfs);
1998 remove_proc_entry("servers", proc_fs_nfs);
1999 remove_proc_entry("fs/nfsfs", NULL);
2000}
2001
2002#endif /* CONFIG_PROC_FS */
2003
2004module_param(nfs4_disable_idmapping, bool, 0644);
2005MODULE_PARM_DESC(nfs4_disable_idmapping,
2006 "Turn off NFSv4 idmapping when using 'sec=sys'");