Merge branch 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jack/linux-fs
[linux/fpc-iii.git] / fs / nfs / client.c
blobefebe6cf4378e32a13d109eebd0b694dd629c2a5
1 /* client.c: NFS client sharing and management code
3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
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>
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"
57 #define NFSDBG_FACILITY NFSDBG_CLIENT
59 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
60 static DEFINE_SPINLOCK(nfs_version_lock);
61 static DEFINE_MUTEX(nfs_version_mutex);
62 static LIST_HEAD(nfs_versions);
65 * RPC cruft for NFS
67 static const struct rpc_version *nfs_version[5] = {
68 [2] = NULL,
69 [3] = NULL,
70 [4] = NULL,
73 const struct rpc_program nfs_program = {
74 .name = "nfs",
75 .number = NFS_PROGRAM,
76 .nrvers = ARRAY_SIZE(nfs_version),
77 .version = nfs_version,
78 .stats = &nfs_rpcstat,
79 .pipe_dir_name = NFS_PIPE_DIRNAME,
82 struct rpc_stat nfs_rpcstat = {
83 .program = &nfs_program
86 static struct nfs_subversion *find_nfs_version(unsigned int version)
88 struct nfs_subversion *nfs;
89 spin_lock(&nfs_version_lock);
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;
98 spin_unlock(&nfs_version_lock);
99 return ERR_PTR(-EPROTONOSUPPORT);
102 struct nfs_subversion *get_nfs_version(unsigned int version)
104 struct nfs_subversion *nfs = find_nfs_version(version);
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);
113 if (!IS_ERR(nfs) && !try_module_get(nfs->owner))
114 return ERR_PTR(-EAGAIN);
115 return nfs;
118 void put_nfs_version(struct nfs_subversion *nfs)
120 module_put(nfs->owner);
123 void register_nfs_version(struct nfs_subversion *nfs)
125 spin_lock(&nfs_version_lock);
127 list_add(&nfs->list, &nfs_versions);
128 nfs_version[nfs->rpc_ops->version] = nfs->rpc_vers;
130 spin_unlock(&nfs_version_lock);
132 EXPORT_SYMBOL_GPL(register_nfs_version);
134 void unregister_nfs_version(struct nfs_subversion *nfs)
136 spin_lock(&nfs_version_lock);
138 nfs_version[nfs->rpc_ops->version] = NULL;
139 list_del(&nfs->list);
141 spin_unlock(&nfs_version_lock);
143 EXPORT_SYMBOL_GPL(unregister_nfs_version);
146 * Allocate a shared client record
148 * Since these are allocated/deallocated very rarely, we don't
149 * bother putting them in a slab cache...
151 struct nfs_client *nfs_alloc_client(const struct nfs_client_initdata *cl_init)
153 struct nfs_client *clp;
154 struct rpc_cred *cred;
155 int err = -ENOMEM;
157 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
158 goto error_0;
160 clp->cl_nfs_mod = cl_init->nfs_mod;
161 if (!try_module_get(clp->cl_nfs_mod->owner))
162 goto error_dealloc;
164 clp->rpc_ops = clp->cl_nfs_mod->rpc_ops;
166 atomic_set(&clp->cl_count, 1);
167 clp->cl_cons_state = NFS_CS_INITING;
169 memcpy(&clp->cl_addr, cl_init->addr, cl_init->addrlen);
170 clp->cl_addrlen = cl_init->addrlen;
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;
179 INIT_LIST_HEAD(&clp->cl_superblocks);
180 clp->cl_rpcclient = ERR_PTR(-EINVAL);
182 clp->cl_proto = cl_init->proto;
183 clp->cl_net = get_net(cl_init->net);
185 cred = rpc_lookup_machine_cred("*");
186 if (!IS_ERR(cred))
187 clp->cl_machine_cred = cred;
188 nfs_fscache_get_client_cookie(clp);
190 return clp;
192 error_cleanup:
193 put_nfs_version(clp->cl_nfs_mod);
194 error_dealloc:
195 kfree(clp);
196 error_0:
197 return ERR_PTR(err);
199 EXPORT_SYMBOL_GPL(nfs_alloc_client);
201 #if IS_ENABLED(CONFIG_NFS_V4)
202 void nfs_cleanup_cb_ident_idr(struct net *net)
204 struct nfs_net *nn = net_generic(net, nfs_net_id);
206 idr_destroy(&nn->cb_ident_idr);
209 /* nfs_client_lock held */
210 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
212 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
214 if (clp->cl_cb_ident)
215 idr_remove(&nn->cb_ident_idr, clp->cl_cb_ident);
218 static void pnfs_init_server(struct nfs_server *server)
220 rpc_init_wait_queue(&server->roc_rpcwaitq, "pNFS ROC");
221 rpc_init_wait_queue(&server->uoc_rpcwaitq, "NFS UOC");
224 #else
225 void nfs_cleanup_cb_ident_idr(struct net *net)
229 static void nfs_cb_idr_remove_locked(struct nfs_client *clp)
233 static void pnfs_init_server(struct nfs_server *server)
237 #endif /* CONFIG_NFS_V4 */
240 * Destroy a shared client record
242 void nfs_free_client(struct nfs_client *clp)
244 nfs_fscache_release_client_cookie(clp);
246 /* -EIO all pending I/O */
247 if (!IS_ERR(clp->cl_rpcclient))
248 rpc_shutdown_client(clp->cl_rpcclient);
250 if (clp->cl_machine_cred != NULL)
251 put_rpccred(clp->cl_machine_cred);
253 put_net(clp->cl_net);
254 put_nfs_version(clp->cl_nfs_mod);
255 kfree(clp->cl_hostname);
256 kfree(clp->cl_acceptor);
257 kfree(clp);
259 EXPORT_SYMBOL_GPL(nfs_free_client);
262 * Release a reference to a shared client record
264 void nfs_put_client(struct nfs_client *clp)
266 struct nfs_net *nn;
268 if (!clp)
269 return;
271 nn = net_generic(clp->cl_net, nfs_net_id);
273 if (atomic_dec_and_lock(&clp->cl_count, &nn->nfs_client_lock)) {
274 list_del(&clp->cl_share_link);
275 nfs_cb_idr_remove_locked(clp);
276 spin_unlock(&nn->nfs_client_lock);
278 WARN_ON_ONCE(!list_empty(&clp->cl_superblocks));
280 clp->rpc_ops->free_client(clp);
283 EXPORT_SYMBOL_GPL(nfs_put_client);
286 * Find an nfs_client on the list that matches the initialisation data
287 * that is supplied.
289 static struct nfs_client *nfs_match_client(const struct nfs_client_initdata *data)
291 struct nfs_client *clp;
292 const struct sockaddr *sap = data->addr;
293 struct nfs_net *nn = net_generic(data->net, nfs_net_id);
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;
301 /* Different NFS versions cannot share the same nfs_client */
302 if (clp->rpc_ops != data->nfs_mod->rpc_ops)
303 continue;
305 if (clp->cl_proto != data->proto)
306 continue;
307 /* Match nfsv4 minorversion */
308 if (clp->cl_minorversion != data->minorversion)
309 continue;
310 /* Match the full socket address */
311 if (!rpc_cmp_addr_port(sap, clap))
312 /* Match all xprt_switch full socket addresses */
313 if (IS_ERR(clp->cl_rpcclient) ||
314 !rpc_clnt_xprt_switch_has_addr(clp->cl_rpcclient,
315 sap))
316 continue;
318 atomic_inc(&clp->cl_count);
319 return clp;
321 return NULL;
325 * Return true if @clp is done initializing, false if still working on it.
327 * Use nfs_client_init_status to check if it was successful.
329 bool nfs_client_init_is_complete(const struct nfs_client *clp)
331 return clp->cl_cons_state <= NFS_CS_READY;
333 EXPORT_SYMBOL_GPL(nfs_client_init_is_complete);
336 * Return 0 if @clp was successfully initialized, -errno otherwise.
338 * This must be called *after* nfs_client_init_is_complete() returns true,
339 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
341 int nfs_client_init_status(const struct nfs_client *clp)
343 /* called without checking nfs_client_init_is_complete */
344 if (clp->cl_cons_state > NFS_CS_READY) {
345 WARN_ON_ONCE(1);
346 return -EINVAL;
348 return clp->cl_cons_state;
350 EXPORT_SYMBOL_GPL(nfs_client_init_status);
352 int nfs_wait_client_init_complete(const struct nfs_client *clp)
354 return wait_event_killable(nfs_client_active_wq,
355 nfs_client_init_is_complete(clp));
357 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete);
360 * Found an existing client. Make sure it's ready before returning.
362 static struct nfs_client *
363 nfs_found_client(const struct nfs_client_initdata *cl_init,
364 struct nfs_client *clp)
366 int error;
368 error = nfs_wait_client_init_complete(clp);
369 if (error < 0) {
370 nfs_put_client(clp);
371 return ERR_PTR(-ERESTARTSYS);
374 if (clp->cl_cons_state < NFS_CS_READY) {
375 error = clp->cl_cons_state;
376 nfs_put_client(clp);
377 return ERR_PTR(error);
380 smp_rmb();
381 return clp;
385 * Look up a client by IP address and protocol version
386 * - creates a new record if one doesn't yet exist
388 struct nfs_client *nfs_get_client(const struct nfs_client_initdata *cl_init)
390 struct nfs_client *clp, *new = NULL;
391 struct nfs_net *nn = net_generic(cl_init->net, nfs_net_id);
392 const struct nfs_rpc_ops *rpc_ops = cl_init->nfs_mod->rpc_ops;
394 if (cl_init->hostname == NULL) {
395 WARN_ON(1);
396 return NULL;
399 /* see if the client already exists */
400 do {
401 spin_lock(&nn->nfs_client_lock);
403 clp = nfs_match_client(cl_init);
404 if (clp) {
405 spin_unlock(&nn->nfs_client_lock);
406 if (new)
407 new->rpc_ops->free_client(new);
408 return nfs_found_client(cl_init, clp);
410 if (new) {
411 list_add_tail(&new->cl_share_link,
412 &nn->nfs_client_list);
413 spin_unlock(&nn->nfs_client_lock);
414 new->cl_flags = cl_init->init_flags;
415 return rpc_ops->init_client(new, cl_init);
418 spin_unlock(&nn->nfs_client_lock);
420 new = rpc_ops->alloc_client(cl_init);
421 } while (!IS_ERR(new));
423 return new;
425 EXPORT_SYMBOL_GPL(nfs_get_client);
428 * Mark a server as ready or failed
430 void nfs_mark_client_ready(struct nfs_client *clp, int state)
432 smp_wmb();
433 clp->cl_cons_state = state;
434 wake_up_all(&nfs_client_active_wq);
436 EXPORT_SYMBOL_GPL(nfs_mark_client_ready);
439 * Initialise the timeout values for a connection
441 void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
442 int timeo, int retrans)
444 to->to_initval = timeo * HZ / 10;
445 to->to_retries = retrans;
447 switch (proto) {
448 case XPRT_TRANSPORT_TCP:
449 case XPRT_TRANSPORT_RDMA:
450 if (retrans == NFS_UNSPEC_RETRANS)
451 to->to_retries = NFS_DEF_TCP_RETRANS;
452 if (timeo == NFS_UNSPEC_TIMEO || to->to_retries == 0)
453 to->to_initval = NFS_DEF_TCP_TIMEO * HZ / 10;
454 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
455 to->to_initval = NFS_MAX_TCP_TIMEOUT;
456 to->to_increment = to->to_initval;
457 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
458 if (to->to_maxval > NFS_MAX_TCP_TIMEOUT)
459 to->to_maxval = NFS_MAX_TCP_TIMEOUT;
460 if (to->to_maxval < to->to_initval)
461 to->to_maxval = to->to_initval;
462 to->to_exponential = 0;
463 break;
464 case XPRT_TRANSPORT_UDP:
465 if (retrans == NFS_UNSPEC_RETRANS)
466 to->to_retries = NFS_DEF_UDP_RETRANS;
467 if (timeo == NFS_UNSPEC_TIMEO || to->to_initval == 0)
468 to->to_initval = NFS_DEF_UDP_TIMEO * HZ / 10;
469 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
470 to->to_initval = NFS_MAX_UDP_TIMEOUT;
471 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
472 to->to_exponential = 1;
473 break;
474 default:
475 BUG();
478 EXPORT_SYMBOL_GPL(nfs_init_timeout_values);
481 * Create an RPC client handle
483 int nfs_create_rpc_client(struct nfs_client *clp,
484 const struct nfs_client_initdata *cl_init,
485 rpc_authflavor_t flavor)
487 struct rpc_clnt *clnt = NULL;
488 struct rpc_create_args args = {
489 .net = clp->cl_net,
490 .protocol = clp->cl_proto,
491 .address = (struct sockaddr *)&clp->cl_addr,
492 .addrsize = clp->cl_addrlen,
493 .timeout = cl_init->timeparms,
494 .servername = clp->cl_hostname,
495 .nodename = cl_init->nodename,
496 .program = &nfs_program,
497 .version = clp->rpc_ops->version,
498 .authflavor = flavor,
501 if (test_bit(NFS_CS_DISCRTRY, &clp->cl_flags))
502 args.flags |= RPC_CLNT_CREATE_DISCRTRY;
503 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags))
504 args.flags |= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT;
505 if (test_bit(NFS_CS_NORESVPORT, &clp->cl_flags))
506 args.flags |= RPC_CLNT_CREATE_NONPRIVPORT;
507 if (test_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags))
508 args.flags |= RPC_CLNT_CREATE_INFINITE_SLOTS;
510 if (!IS_ERR(clp->cl_rpcclient))
511 return 0;
513 clnt = rpc_create(&args);
514 if (IS_ERR(clnt)) {
515 dprintk("%s: cannot create RPC client. Error = %ld\n",
516 __func__, PTR_ERR(clnt));
517 return PTR_ERR(clnt);
520 clp->cl_rpcclient = clnt;
521 return 0;
523 EXPORT_SYMBOL_GPL(nfs_create_rpc_client);
526 * Version 2 or 3 client destruction
528 static void nfs_destroy_server(struct nfs_server *server)
530 if (server->nlm_host)
531 nlmclnt_done(server->nlm_host);
535 * Version 2 or 3 lockd setup
537 static int nfs_start_lockd(struct nfs_server *server)
539 struct nlm_host *host;
540 struct nfs_client *clp = server->nfs_client;
541 struct nlmclnt_initdata nlm_init = {
542 .hostname = clp->cl_hostname,
543 .address = (struct sockaddr *)&clp->cl_addr,
544 .addrlen = clp->cl_addrlen,
545 .nfs_version = clp->rpc_ops->version,
546 .noresvport = server->flags & NFS_MOUNT_NORESVPORT ?
547 1 : 0,
548 .net = clp->cl_net,
549 .nlmclnt_ops = clp->cl_nfs_mod->rpc_ops->nlmclnt_ops,
552 if (nlm_init.nfs_version > 3)
553 return 0;
554 if ((server->flags & NFS_MOUNT_LOCAL_FLOCK) &&
555 (server->flags & NFS_MOUNT_LOCAL_FCNTL))
556 return 0;
558 switch (clp->cl_proto) {
559 default:
560 nlm_init.protocol = IPPROTO_TCP;
561 break;
562 case XPRT_TRANSPORT_UDP:
563 nlm_init.protocol = IPPROTO_UDP;
566 host = nlmclnt_init(&nlm_init);
567 if (IS_ERR(host))
568 return PTR_ERR(host);
570 server->nlm_host = host;
571 server->destroy = nfs_destroy_server;
572 return 0;
576 * Create a general RPC client
578 int nfs_init_server_rpcclient(struct nfs_server *server,
579 const struct rpc_timeout *timeo,
580 rpc_authflavor_t pseudoflavour)
582 struct nfs_client *clp = server->nfs_client;
584 server->client = rpc_clone_client_set_auth(clp->cl_rpcclient,
585 pseudoflavour);
586 if (IS_ERR(server->client)) {
587 dprintk("%s: couldn't create rpc_client!\n", __func__);
588 return PTR_ERR(server->client);
591 memcpy(&server->client->cl_timeout_default,
592 timeo,
593 sizeof(server->client->cl_timeout_default));
594 server->client->cl_timeout = &server->client->cl_timeout_default;
595 server->client->cl_softrtry = 0;
596 if (server->flags & NFS_MOUNT_SOFT)
597 server->client->cl_softrtry = 1;
599 return 0;
601 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient);
604 * nfs_init_client - Initialise an NFS2 or NFS3 client
606 * @clp: nfs_client to initialise
607 * @cl_init: Initialisation parameters
609 * Returns pointer to an NFS client, or an ERR_PTR value.
611 struct nfs_client *nfs_init_client(struct nfs_client *clp,
612 const struct nfs_client_initdata *cl_init)
614 int error;
616 /* the client is already initialised */
617 if (clp->cl_cons_state == NFS_CS_READY)
618 return clp;
621 * Create a client RPC handle for doing FSSTAT with UNIX auth only
622 * - RFC 2623, sec 2.3.2
624 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
625 nfs_mark_client_ready(clp, error == 0 ? NFS_CS_READY : error);
626 if (error < 0) {
627 nfs_put_client(clp);
628 clp = ERR_PTR(error);
630 return clp;
632 EXPORT_SYMBOL_GPL(nfs_init_client);
635 * Create a version 2 or 3 client
637 static int nfs_init_server(struct nfs_server *server,
638 const struct nfs_parsed_mount_data *data,
639 struct nfs_subversion *nfs_mod)
641 struct rpc_timeout timeparms;
642 struct nfs_client_initdata cl_init = {
643 .hostname = data->nfs_server.hostname,
644 .addr = (const struct sockaddr *)&data->nfs_server.address,
645 .addrlen = data->nfs_server.addrlen,
646 .nfs_mod = nfs_mod,
647 .proto = data->nfs_server.protocol,
648 .net = data->net,
649 .timeparms = &timeparms,
651 struct nfs_client *clp;
652 int error;
654 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
655 data->timeo, data->retrans);
656 if (data->flags & NFS_MOUNT_NORESVPORT)
657 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
659 /* Allocate or find a client reference we can use */
660 clp = nfs_get_client(&cl_init);
661 if (IS_ERR(clp))
662 return PTR_ERR(clp);
664 server->nfs_client = clp;
666 /* Initialise the client representation from the mount data */
667 server->flags = data->flags;
668 server->options = data->options;
669 server->caps |= NFS_CAP_HARDLINKS|NFS_CAP_SYMLINKS|NFS_CAP_FILEID|
670 NFS_CAP_MODE|NFS_CAP_NLINK|NFS_CAP_OWNER|NFS_CAP_OWNER_GROUP|
671 NFS_CAP_ATIME|NFS_CAP_CTIME|NFS_CAP_MTIME;
673 if (data->rsize)
674 server->rsize = nfs_block_size(data->rsize, NULL);
675 if (data->wsize)
676 server->wsize = nfs_block_size(data->wsize, NULL);
678 server->acregmin = data->acregmin * HZ;
679 server->acregmax = data->acregmax * HZ;
680 server->acdirmin = data->acdirmin * HZ;
681 server->acdirmax = data->acdirmax * HZ;
683 /* Start lockd here, before we might error out */
684 error = nfs_start_lockd(server);
685 if (error < 0)
686 goto error;
688 server->port = data->nfs_server.port;
689 server->auth_info = data->auth_info;
691 error = nfs_init_server_rpcclient(server, &timeparms,
692 data->selected_flavor);
693 if (error < 0)
694 goto error;
696 /* Preserve the values of mount_server-related mount options */
697 if (data->mount_server.addrlen) {
698 memcpy(&server->mountd_address, &data->mount_server.address,
699 data->mount_server.addrlen);
700 server->mountd_addrlen = data->mount_server.addrlen;
702 server->mountd_version = data->mount_server.version;
703 server->mountd_port = data->mount_server.port;
704 server->mountd_protocol = data->mount_server.protocol;
706 server->namelen = data->namlen;
707 return 0;
709 error:
710 server->nfs_client = NULL;
711 nfs_put_client(clp);
712 return error;
716 * Load up the server record from information gained in an fsinfo record
718 static void nfs_server_set_fsinfo(struct nfs_server *server,
719 struct nfs_fsinfo *fsinfo)
721 unsigned long max_rpc_payload;
723 /* Work out a lot of parameters */
724 if (server->rsize == 0)
725 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
726 if (server->wsize == 0)
727 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
729 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
730 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
731 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
732 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
734 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
735 if (server->rsize > max_rpc_payload)
736 server->rsize = max_rpc_payload;
737 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
738 server->rsize = NFS_MAX_FILE_IO_SIZE;
739 server->rpages = (server->rsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
741 if (server->wsize > max_rpc_payload)
742 server->wsize = max_rpc_payload;
743 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
744 server->wsize = NFS_MAX_FILE_IO_SIZE;
745 server->wpages = (server->wsize + PAGE_SIZE - 1) >> PAGE_SHIFT;
747 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
749 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
750 if (server->dtsize > PAGE_SIZE * NFS_MAX_READDIR_PAGES)
751 server->dtsize = PAGE_SIZE * NFS_MAX_READDIR_PAGES;
752 if (server->dtsize > server->rsize)
753 server->dtsize = server->rsize;
755 if (server->flags & NFS_MOUNT_NOAC) {
756 server->acregmin = server->acregmax = 0;
757 server->acdirmin = server->acdirmax = 0;
760 server->maxfilesize = fsinfo->maxfilesize;
762 server->time_delta = fsinfo->time_delta;
764 server->clone_blksize = fsinfo->clone_blksize;
765 /* We're airborne Set socket buffersize */
766 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
770 * Probe filesystem information, including the FSID on v2/v3
772 int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
774 struct nfs_fsinfo fsinfo;
775 struct nfs_client *clp = server->nfs_client;
776 int error;
778 if (clp->rpc_ops->set_capabilities != NULL) {
779 error = clp->rpc_ops->set_capabilities(server, mntfh);
780 if (error < 0)
781 return error;
784 fsinfo.fattr = fattr;
785 fsinfo.nlayouttypes = 0;
786 memset(fsinfo.layouttype, 0, sizeof(fsinfo.layouttype));
787 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
788 if (error < 0)
789 return error;
791 nfs_server_set_fsinfo(server, &fsinfo);
793 /* Get some general file system info */
794 if (server->namelen == 0) {
795 struct nfs_pathconf pathinfo;
797 pathinfo.fattr = fattr;
798 nfs_fattr_init(fattr);
800 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
801 server->namelen = pathinfo.max_namelen;
804 return 0;
806 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo);
809 * Copy useful information when duplicating a server record
811 void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
813 target->flags = source->flags;
814 target->rsize = source->rsize;
815 target->wsize = source->wsize;
816 target->acregmin = source->acregmin;
817 target->acregmax = source->acregmax;
818 target->acdirmin = source->acdirmin;
819 target->acdirmax = source->acdirmax;
820 target->caps = source->caps;
821 target->options = source->options;
822 target->auth_info = source->auth_info;
823 target->port = source->port;
825 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata);
827 void nfs_server_insert_lists(struct nfs_server *server)
829 struct nfs_client *clp = server->nfs_client;
830 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
832 spin_lock(&nn->nfs_client_lock);
833 list_add_tail_rcu(&server->client_link, &clp->cl_superblocks);
834 list_add_tail(&server->master_link, &nn->nfs_volume_list);
835 clear_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
836 spin_unlock(&nn->nfs_client_lock);
839 EXPORT_SYMBOL_GPL(nfs_server_insert_lists);
841 void nfs_server_remove_lists(struct nfs_server *server)
843 struct nfs_client *clp = server->nfs_client;
844 struct nfs_net *nn;
846 if (clp == NULL)
847 return;
848 nn = net_generic(clp->cl_net, nfs_net_id);
849 spin_lock(&nn->nfs_client_lock);
850 list_del_rcu(&server->client_link);
851 if (list_empty(&clp->cl_superblocks))
852 set_bit(NFS_CS_STOP_RENEW, &clp->cl_res_state);
853 list_del(&server->master_link);
854 spin_unlock(&nn->nfs_client_lock);
856 synchronize_rcu();
858 EXPORT_SYMBOL_GPL(nfs_server_remove_lists);
861 * Allocate and initialise a server record
863 struct nfs_server *nfs_alloc_server(void)
865 struct nfs_server *server;
867 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
868 if (!server)
869 return NULL;
871 server->client = server->client_acl = ERR_PTR(-EINVAL);
873 /* Zero out the NFS state stuff */
874 INIT_LIST_HEAD(&server->client_link);
875 INIT_LIST_HEAD(&server->master_link);
876 INIT_LIST_HEAD(&server->delegations);
877 INIT_LIST_HEAD(&server->layouts);
878 INIT_LIST_HEAD(&server->state_owners_lru);
880 atomic_set(&server->active, 0);
882 server->io_stats = nfs_alloc_iostats();
883 if (!server->io_stats) {
884 kfree(server);
885 return NULL;
888 ida_init(&server->openowner_id);
889 ida_init(&server->lockowner_id);
890 pnfs_init_server(server);
892 return server;
894 EXPORT_SYMBOL_GPL(nfs_alloc_server);
897 * Free up a server record
899 void nfs_free_server(struct nfs_server *server)
901 nfs_server_remove_lists(server);
903 if (server->destroy != NULL)
904 server->destroy(server);
906 if (!IS_ERR(server->client_acl))
907 rpc_shutdown_client(server->client_acl);
908 if (!IS_ERR(server->client))
909 rpc_shutdown_client(server->client);
911 nfs_put_client(server->nfs_client);
913 ida_destroy(&server->lockowner_id);
914 ida_destroy(&server->openowner_id);
915 nfs_free_iostats(server->io_stats);
916 kfree(server);
917 nfs_release_automount_timer();
919 EXPORT_SYMBOL_GPL(nfs_free_server);
922 * Create a version 2 or 3 volume record
923 * - keyed on server and FSID
925 struct nfs_server *nfs_create_server(struct nfs_mount_info *mount_info,
926 struct nfs_subversion *nfs_mod)
928 struct nfs_server *server;
929 struct nfs_fattr *fattr;
930 int error;
932 server = nfs_alloc_server();
933 if (!server)
934 return ERR_PTR(-ENOMEM);
936 error = -ENOMEM;
937 fattr = nfs_alloc_fattr();
938 if (fattr == NULL)
939 goto error;
941 /* Get a client representation */
942 error = nfs_init_server(server, mount_info->parsed, nfs_mod);
943 if (error < 0)
944 goto error;
946 /* Probe the root fh to retrieve its FSID */
947 error = nfs_probe_fsinfo(server, mount_info->mntfh, fattr);
948 if (error < 0)
949 goto error;
950 if (server->nfs_client->rpc_ops->version == 3) {
951 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
952 server->namelen = NFS3_MAXNAMLEN;
953 if (!(mount_info->parsed->flags & NFS_MOUNT_NORDIRPLUS))
954 server->caps |= NFS_CAP_READDIRPLUS;
955 } else {
956 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
957 server->namelen = NFS2_MAXNAMLEN;
960 if (!(fattr->valid & NFS_ATTR_FATTR)) {
961 error = nfs_mod->rpc_ops->getattr(server, mount_info->mntfh, fattr, NULL);
962 if (error < 0) {
963 dprintk("nfs_create_server: getattr error = %d\n", -error);
964 goto error;
967 memcpy(&server->fsid, &fattr->fsid, sizeof(server->fsid));
969 dprintk("Server FSID: %llx:%llx\n",
970 (unsigned long long) server->fsid.major,
971 (unsigned long long) server->fsid.minor);
973 nfs_server_insert_lists(server);
974 server->mount_time = jiffies;
975 nfs_free_fattr(fattr);
976 return server;
978 error:
979 nfs_free_fattr(fattr);
980 nfs_free_server(server);
981 return ERR_PTR(error);
983 EXPORT_SYMBOL_GPL(nfs_create_server);
986 * Clone an NFS2, NFS3 or NFS4 server record
988 struct nfs_server *nfs_clone_server(struct nfs_server *source,
989 struct nfs_fh *fh,
990 struct nfs_fattr *fattr,
991 rpc_authflavor_t flavor)
993 struct nfs_server *server;
994 struct nfs_fattr *fattr_fsinfo;
995 int error;
997 server = nfs_alloc_server();
998 if (!server)
999 return ERR_PTR(-ENOMEM);
1001 error = -ENOMEM;
1002 fattr_fsinfo = nfs_alloc_fattr();
1003 if (fattr_fsinfo == NULL)
1004 goto out_free_server;
1006 /* Copy data from the source */
1007 server->nfs_client = source->nfs_client;
1008 server->destroy = source->destroy;
1009 atomic_inc(&server->nfs_client->cl_count);
1010 nfs_server_copy_userdata(server, source);
1012 server->fsid = fattr->fsid;
1014 error = nfs_init_server_rpcclient(server,
1015 source->client->cl_timeout,
1016 flavor);
1017 if (error < 0)
1018 goto out_free_server;
1020 /* probe the filesystem info for this server filesystem */
1021 error = nfs_probe_fsinfo(server, fh, fattr_fsinfo);
1022 if (error < 0)
1023 goto out_free_server;
1025 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1026 server->namelen = NFS4_MAXNAMLEN;
1028 error = nfs_start_lockd(server);
1029 if (error < 0)
1030 goto out_free_server;
1032 nfs_server_insert_lists(server);
1033 server->mount_time = jiffies;
1035 nfs_free_fattr(fattr_fsinfo);
1036 return server;
1038 out_free_server:
1039 nfs_free_fattr(fattr_fsinfo);
1040 nfs_free_server(server);
1041 return ERR_PTR(error);
1043 EXPORT_SYMBOL_GPL(nfs_clone_server);
1045 void nfs_clients_init(struct net *net)
1047 struct nfs_net *nn = net_generic(net, nfs_net_id);
1049 INIT_LIST_HEAD(&nn->nfs_client_list);
1050 INIT_LIST_HEAD(&nn->nfs_volume_list);
1051 #if IS_ENABLED(CONFIG_NFS_V4)
1052 idr_init(&nn->cb_ident_idr);
1053 #endif
1054 spin_lock_init(&nn->nfs_client_lock);
1055 nn->boot_time = ktime_get_real();
1058 #ifdef CONFIG_PROC_FS
1059 static int nfs_server_list_open(struct inode *inode, struct file *file);
1060 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1061 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1062 static void nfs_server_list_stop(struct seq_file *p, void *v);
1063 static int nfs_server_list_show(struct seq_file *m, void *v);
1065 static const struct seq_operations nfs_server_list_ops = {
1066 .start = nfs_server_list_start,
1067 .next = nfs_server_list_next,
1068 .stop = nfs_server_list_stop,
1069 .show = nfs_server_list_show,
1072 static const struct file_operations nfs_server_list_fops = {
1073 .open = nfs_server_list_open,
1074 .read = seq_read,
1075 .llseek = seq_lseek,
1076 .release = seq_release_net,
1079 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1080 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1081 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1082 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1083 static int nfs_volume_list_show(struct seq_file *m, void *v);
1085 static const struct seq_operations nfs_volume_list_ops = {
1086 .start = nfs_volume_list_start,
1087 .next = nfs_volume_list_next,
1088 .stop = nfs_volume_list_stop,
1089 .show = nfs_volume_list_show,
1092 static const struct file_operations nfs_volume_list_fops = {
1093 .open = nfs_volume_list_open,
1094 .read = seq_read,
1095 .llseek = seq_lseek,
1096 .release = seq_release_net,
1100 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1101 * we're dealing
1103 static int nfs_server_list_open(struct inode *inode, struct file *file)
1105 return seq_open_net(inode, file, &nfs_server_list_ops,
1106 sizeof(struct seq_net_private));
1110 * set up the iterator to start reading from the server list and return the first item
1112 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1113 __acquires(&nn->nfs_client_lock)
1115 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1117 /* lock the list against modification */
1118 spin_lock(&nn->nfs_client_lock);
1119 return seq_list_start_head(&nn->nfs_client_list, *_pos);
1123 * move to next server
1125 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1127 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1129 return seq_list_next(v, &nn->nfs_client_list, pos);
1133 * clean up after reading from the transports list
1135 static void nfs_server_list_stop(struct seq_file *p, void *v)
1136 __releases(&nn->nfs_client_lock)
1138 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1140 spin_unlock(&nn->nfs_client_lock);
1144 * display a header line followed by a load of call lines
1146 static int nfs_server_list_show(struct seq_file *m, void *v)
1148 struct nfs_client *clp;
1149 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1151 /* display header on line 1 */
1152 if (v == &nn->nfs_client_list) {
1153 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1154 return 0;
1157 /* display one transport per line on subsequent lines */
1158 clp = list_entry(v, struct nfs_client, cl_share_link);
1160 /* Check if the client is initialized */
1161 if (clp->cl_cons_state != NFS_CS_READY)
1162 return 0;
1164 rcu_read_lock();
1165 seq_printf(m, "v%u %s %s %3d %s\n",
1166 clp->rpc_ops->version,
1167 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1168 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1169 atomic_read(&clp->cl_count),
1170 clp->cl_hostname);
1171 rcu_read_unlock();
1173 return 0;
1177 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1179 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1181 return seq_open_net(inode, file, &nfs_volume_list_ops,
1182 sizeof(struct seq_net_private));
1186 * set up the iterator to start reading from the volume list and return the first item
1188 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1189 __acquires(&nn->nfs_client_lock)
1191 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1193 /* lock the list against modification */
1194 spin_lock(&nn->nfs_client_lock);
1195 return seq_list_start_head(&nn->nfs_volume_list, *_pos);
1199 * move to next volume
1201 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1203 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1205 return seq_list_next(v, &nn->nfs_volume_list, pos);
1209 * clean up after reading from the transports list
1211 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1212 __releases(&nn->nfs_client_lock)
1214 struct nfs_net *nn = net_generic(seq_file_net(p), nfs_net_id);
1216 spin_unlock(&nn->nfs_client_lock);
1220 * display a header line followed by a load of call lines
1222 static int nfs_volume_list_show(struct seq_file *m, void *v)
1224 struct nfs_server *server;
1225 struct nfs_client *clp;
1226 char dev[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1227 char fsid[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1228 struct nfs_net *nn = net_generic(seq_file_net(m), nfs_net_id);
1230 /* display header on line 1 */
1231 if (v == &nn->nfs_volume_list) {
1232 seq_puts(m, "NV SERVER PORT DEV FSID"
1233 " FSC\n");
1234 return 0;
1236 /* display one transport per line on subsequent lines */
1237 server = list_entry(v, struct nfs_server, master_link);
1238 clp = server->nfs_client;
1240 snprintf(dev, sizeof(dev), "%u:%u",
1241 MAJOR(server->s_dev), MINOR(server->s_dev));
1243 snprintf(fsid, sizeof(fsid), "%llx:%llx",
1244 (unsigned long long) server->fsid.major,
1245 (unsigned long long) server->fsid.minor);
1247 rcu_read_lock();
1248 seq_printf(m, "v%u %s %s %-12s %-33s %s\n",
1249 clp->rpc_ops->version,
1250 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_ADDR),
1251 rpc_peeraddr2str(clp->cl_rpcclient, RPC_DISPLAY_HEX_PORT),
1252 dev,
1253 fsid,
1254 nfs_server_fscache_state(server));
1255 rcu_read_unlock();
1257 return 0;
1260 int nfs_fs_proc_net_init(struct net *net)
1262 struct nfs_net *nn = net_generic(net, nfs_net_id);
1263 struct proc_dir_entry *p;
1265 nn->proc_nfsfs = proc_net_mkdir(net, "nfsfs", net->proc_net);
1266 if (!nn->proc_nfsfs)
1267 goto error_0;
1269 /* a file of servers with which we're dealing */
1270 p = proc_create("servers", S_IFREG|S_IRUGO,
1271 nn->proc_nfsfs, &nfs_server_list_fops);
1272 if (!p)
1273 goto error_1;
1275 /* a file of volumes that we have mounted */
1276 p = proc_create("volumes", S_IFREG|S_IRUGO,
1277 nn->proc_nfsfs, &nfs_volume_list_fops);
1278 if (!p)
1279 goto error_1;
1280 return 0;
1282 error_1:
1283 remove_proc_subtree("nfsfs", net->proc_net);
1284 error_0:
1285 return -ENOMEM;
1288 void nfs_fs_proc_net_exit(struct net *net)
1290 remove_proc_subtree("nfsfs", net->proc_net);
1294 * initialise the /proc/fs/nfsfs/ directory
1296 int __init nfs_fs_proc_init(void)
1298 if (!proc_mkdir("fs/nfsfs", NULL))
1299 goto error_0;
1301 /* a file of servers with which we're dealing */
1302 if (!proc_symlink("fs/nfsfs/servers", NULL, "../../net/nfsfs/servers"))
1303 goto error_1;
1305 /* a file of volumes that we have mounted */
1306 if (!proc_symlink("fs/nfsfs/volumes", NULL, "../../net/nfsfs/volumes"))
1307 goto error_1;
1309 return 0;
1310 error_1:
1311 remove_proc_subtree("fs/nfsfs", NULL);
1312 error_0:
1313 return -ENOMEM;
1317 * clean up the /proc/fs/nfsfs/ directory
1319 void nfs_fs_proc_exit(void)
1321 remove_proc_subtree("fs/nfsfs", NULL);
1324 #endif /* CONFIG_PROC_FS */