1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* client.c: NFS client sharing and management code
4 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
9 #include <linux/module.h>
10 #include <linux/init.h>
11 #include <linux/sched.h>
12 #include <linux/time.h>
13 #include <linux/kernel.h>
15 #include <linux/string.h>
16 #include <linux/stat.h>
17 #include <linux/errno.h>
18 #include <linux/unistd.h>
19 #include <linux/sunrpc/addr.h>
20 #include <linux/sunrpc/clnt.h>
21 #include <linux/sunrpc/stats.h>
22 #include <linux/sunrpc/metrics.h>
23 #include <linux/sunrpc/xprtsock.h>
24 #include <linux/sunrpc/xprtrdma.h>
25 #include <linux/nfs_fs.h>
26 #include <linux/nfs_mount.h>
27 #include <linux/nfs4_mount.h>
28 #include <linux/lockd/bind.h>
29 #include <linux/seq_file.h>
30 #include <linux/mount.h>
31 #include <linux/vfs.h>
32 #include <linux/inet.h>
33 #include <linux/in6.h>
34 #include <linux/slab.h>
35 #include <linux/idr.h>
37 #include <linux/nfs_xdr.h>
38 #include <linux/sunrpc/bc_xprt.h>
39 #include <linux/nsproxy.h>
40 #include <linux/pid_namespace.h>
45 #include "delegation.h"
54 #define NFSDBG_FACILITY NFSDBG_CLIENT
56 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq
);
57 static DEFINE_SPINLOCK(nfs_version_lock
);
58 static DEFINE_MUTEX(nfs_version_mutex
);
59 static LIST_HEAD(nfs_versions
);
64 static const struct rpc_version
*nfs_version
[5] = {
70 const struct rpc_program nfs_program
= {
72 .number
= NFS_PROGRAM
,
73 .nrvers
= ARRAY_SIZE(nfs_version
),
74 .version
= nfs_version
,
75 .stats
= &nfs_rpcstat
,
76 .pipe_dir_name
= NFS_PIPE_DIRNAME
,
79 struct rpc_stat nfs_rpcstat
= {
80 .program
= &nfs_program
83 static struct nfs_subversion
*find_nfs_version(unsigned int version
)
85 struct nfs_subversion
*nfs
;
86 spin_lock(&nfs_version_lock
);
88 list_for_each_entry(nfs
, &nfs_versions
, list
) {
89 if (nfs
->rpc_ops
->version
== version
) {
90 spin_unlock(&nfs_version_lock
);
95 spin_unlock(&nfs_version_lock
);
96 return ERR_PTR(-EPROTONOSUPPORT
);
99 struct nfs_subversion
*get_nfs_version(unsigned int version
)
101 struct nfs_subversion
*nfs
= find_nfs_version(version
);
104 mutex_lock(&nfs_version_mutex
);
105 request_module("nfsv%d", version
);
106 nfs
= find_nfs_version(version
);
107 mutex_unlock(&nfs_version_mutex
);
110 if (!IS_ERR(nfs
) && !try_module_get(nfs
->owner
))
111 return ERR_PTR(-EAGAIN
);
115 void put_nfs_version(struct nfs_subversion
*nfs
)
117 module_put(nfs
->owner
);
120 void register_nfs_version(struct nfs_subversion
*nfs
)
122 spin_lock(&nfs_version_lock
);
124 list_add(&nfs
->list
, &nfs_versions
);
125 nfs_version
[nfs
->rpc_ops
->version
] = nfs
->rpc_vers
;
127 spin_unlock(&nfs_version_lock
);
129 EXPORT_SYMBOL_GPL(register_nfs_version
);
131 void unregister_nfs_version(struct nfs_subversion
*nfs
)
133 spin_lock(&nfs_version_lock
);
135 nfs_version
[nfs
->rpc_ops
->version
] = NULL
;
136 list_del(&nfs
->list
);
138 spin_unlock(&nfs_version_lock
);
140 EXPORT_SYMBOL_GPL(unregister_nfs_version
);
143 * Allocate a shared client record
145 * Since these are allocated/deallocated very rarely, we don't
146 * bother putting them in a slab cache...
148 struct nfs_client
*nfs_alloc_client(const struct nfs_client_initdata
*cl_init
)
150 struct nfs_client
*clp
;
153 if ((clp
= kzalloc(sizeof(*clp
), GFP_KERNEL
)) == NULL
)
156 clp
->cl_minorversion
= cl_init
->minorversion
;
157 clp
->cl_nfs_mod
= cl_init
->nfs_mod
;
158 if (!try_module_get(clp
->cl_nfs_mod
->owner
))
161 clp
->rpc_ops
= clp
->cl_nfs_mod
->rpc_ops
;
163 refcount_set(&clp
->cl_count
, 1);
164 clp
->cl_cons_state
= NFS_CS_INITING
;
166 memcpy(&clp
->cl_addr
, cl_init
->addr
, cl_init
->addrlen
);
167 clp
->cl_addrlen
= cl_init
->addrlen
;
169 if (cl_init
->hostname
) {
171 clp
->cl_hostname
= kstrdup(cl_init
->hostname
, GFP_KERNEL
);
172 if (!clp
->cl_hostname
)
176 INIT_LIST_HEAD(&clp
->cl_superblocks
);
177 clp
->cl_rpcclient
= ERR_PTR(-EINVAL
);
179 clp
->cl_flags
= cl_init
->init_flags
;
180 clp
->cl_proto
= cl_init
->proto
;
181 clp
->cl_nconnect
= cl_init
->nconnect
;
182 clp
->cl_net
= get_net(cl_init
->net
);
184 clp
->cl_principal
= "*";
185 nfs_fscache_get_client_cookie(clp
);
190 put_nfs_version(clp
->cl_nfs_mod
);
196 EXPORT_SYMBOL_GPL(nfs_alloc_client
);
198 #if IS_ENABLED(CONFIG_NFS_V4)
199 static void nfs_cleanup_cb_ident_idr(struct net
*net
)
201 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
203 idr_destroy(&nn
->cb_ident_idr
);
206 /* nfs_client_lock held */
207 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
209 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
211 if (clp
->cl_cb_ident
)
212 idr_remove(&nn
->cb_ident_idr
, clp
->cl_cb_ident
);
215 static void pnfs_init_server(struct nfs_server
*server
)
217 rpc_init_wait_queue(&server
->roc_rpcwaitq
, "pNFS ROC");
221 static void nfs_cleanup_cb_ident_idr(struct net
*net
)
225 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
229 static void pnfs_init_server(struct nfs_server
*server
)
233 #endif /* CONFIG_NFS_V4 */
236 * Destroy a shared client record
238 void nfs_free_client(struct nfs_client
*clp
)
240 nfs_fscache_release_client_cookie(clp
);
242 /* -EIO all pending I/O */
243 if (!IS_ERR(clp
->cl_rpcclient
))
244 rpc_shutdown_client(clp
->cl_rpcclient
);
246 put_net(clp
->cl_net
);
247 put_nfs_version(clp
->cl_nfs_mod
);
248 kfree(clp
->cl_hostname
);
249 kfree(clp
->cl_acceptor
);
252 EXPORT_SYMBOL_GPL(nfs_free_client
);
255 * Release a reference to a shared client record
257 void nfs_put_client(struct nfs_client
*clp
)
264 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
266 if (refcount_dec_and_lock(&clp
->cl_count
, &nn
->nfs_client_lock
)) {
267 list_del(&clp
->cl_share_link
);
268 nfs_cb_idr_remove_locked(clp
);
269 spin_unlock(&nn
->nfs_client_lock
);
271 WARN_ON_ONCE(!list_empty(&clp
->cl_superblocks
));
273 clp
->rpc_ops
->free_client(clp
);
276 EXPORT_SYMBOL_GPL(nfs_put_client
);
279 * Find an nfs_client on the list that matches the initialisation data
282 static struct nfs_client
*nfs_match_client(const struct nfs_client_initdata
*data
)
284 struct nfs_client
*clp
;
285 const struct sockaddr
*sap
= data
->addr
;
286 struct nfs_net
*nn
= net_generic(data
->net
, nfs_net_id
);
290 list_for_each_entry(clp
, &nn
->nfs_client_list
, cl_share_link
) {
291 const struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
292 /* Don't match clients that failed to initialise properly */
293 if (clp
->cl_cons_state
< 0)
296 /* If a client is still initializing then we need to wait */
297 if (clp
->cl_cons_state
> NFS_CS_READY
) {
298 refcount_inc(&clp
->cl_count
);
299 spin_unlock(&nn
->nfs_client_lock
);
300 error
= nfs_wait_client_init_complete(clp
);
302 spin_lock(&nn
->nfs_client_lock
);
304 return ERR_PTR(error
);
308 /* Different NFS versions cannot share the same nfs_client */
309 if (clp
->rpc_ops
!= data
->nfs_mod
->rpc_ops
)
312 if (clp
->cl_proto
!= data
->proto
)
314 /* Match nfsv4 minorversion */
315 if (clp
->cl_minorversion
!= data
->minorversion
)
317 /* Match the full socket address */
318 if (!rpc_cmp_addr_port(sap
, clap
))
319 /* Match all xprt_switch full socket addresses */
320 if (IS_ERR(clp
->cl_rpcclient
) ||
321 !rpc_clnt_xprt_switch_has_addr(clp
->cl_rpcclient
,
325 refcount_inc(&clp
->cl_count
);
332 * Return true if @clp is done initializing, false if still working on it.
334 * Use nfs_client_init_status to check if it was successful.
336 bool nfs_client_init_is_complete(const struct nfs_client
*clp
)
338 return clp
->cl_cons_state
<= NFS_CS_READY
;
340 EXPORT_SYMBOL_GPL(nfs_client_init_is_complete
);
343 * Return 0 if @clp was successfully initialized, -errno otherwise.
345 * This must be called *after* nfs_client_init_is_complete() returns true,
346 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
348 int nfs_client_init_status(const struct nfs_client
*clp
)
350 /* called without checking nfs_client_init_is_complete */
351 if (clp
->cl_cons_state
> NFS_CS_READY
) {
355 return clp
->cl_cons_state
;
357 EXPORT_SYMBOL_GPL(nfs_client_init_status
);
359 int nfs_wait_client_init_complete(const struct nfs_client
*clp
)
361 return wait_event_killable(nfs_client_active_wq
,
362 nfs_client_init_is_complete(clp
));
364 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete
);
367 * Found an existing client. Make sure it's ready before returning.
369 static struct nfs_client
*
370 nfs_found_client(const struct nfs_client_initdata
*cl_init
,
371 struct nfs_client
*clp
)
375 error
= nfs_wait_client_init_complete(clp
);
378 return ERR_PTR(-ERESTARTSYS
);
381 if (clp
->cl_cons_state
< NFS_CS_READY
) {
382 error
= clp
->cl_cons_state
;
384 return ERR_PTR(error
);
392 * Look up a client by IP address and protocol version
393 * - creates a new record if one doesn't yet exist
395 struct nfs_client
*nfs_get_client(const struct nfs_client_initdata
*cl_init
)
397 struct nfs_client
*clp
, *new = NULL
;
398 struct nfs_net
*nn
= net_generic(cl_init
->net
, nfs_net_id
);
399 const struct nfs_rpc_ops
*rpc_ops
= cl_init
->nfs_mod
->rpc_ops
;
401 if (cl_init
->hostname
== NULL
) {
403 return ERR_PTR(-EINVAL
);
406 /* see if the client already exists */
408 spin_lock(&nn
->nfs_client_lock
);
410 clp
= nfs_match_client(cl_init
);
412 spin_unlock(&nn
->nfs_client_lock
);
414 new->rpc_ops
->free_client(new);
417 return nfs_found_client(cl_init
, clp
);
420 list_add_tail(&new->cl_share_link
,
421 &nn
->nfs_client_list
);
422 spin_unlock(&nn
->nfs_client_lock
);
423 return rpc_ops
->init_client(new, cl_init
);
426 spin_unlock(&nn
->nfs_client_lock
);
428 new = rpc_ops
->alloc_client(cl_init
);
429 } while (!IS_ERR(new));
433 EXPORT_SYMBOL_GPL(nfs_get_client
);
436 * Mark a server as ready or failed
438 void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
441 clp
->cl_cons_state
= state
;
442 wake_up_all(&nfs_client_active_wq
);
444 EXPORT_SYMBOL_GPL(nfs_mark_client_ready
);
447 * Initialise the timeout values for a connection
449 void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
450 int timeo
, int retrans
)
452 to
->to_initval
= timeo
* HZ
/ 10;
453 to
->to_retries
= retrans
;
456 case XPRT_TRANSPORT_TCP
:
457 case XPRT_TRANSPORT_RDMA
:
458 if (retrans
== NFS_UNSPEC_RETRANS
)
459 to
->to_retries
= NFS_DEF_TCP_RETRANS
;
460 if (timeo
== NFS_UNSPEC_TIMEO
|| to
->to_initval
== 0)
461 to
->to_initval
= NFS_DEF_TCP_TIMEO
* HZ
/ 10;
462 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
463 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
464 to
->to_increment
= to
->to_initval
;
465 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
466 if (to
->to_maxval
> NFS_MAX_TCP_TIMEOUT
)
467 to
->to_maxval
= NFS_MAX_TCP_TIMEOUT
;
468 if (to
->to_maxval
< to
->to_initval
)
469 to
->to_maxval
= to
->to_initval
;
470 to
->to_exponential
= 0;
472 case XPRT_TRANSPORT_UDP
:
473 if (retrans
== NFS_UNSPEC_RETRANS
)
474 to
->to_retries
= NFS_DEF_UDP_RETRANS
;
475 if (timeo
== NFS_UNSPEC_TIMEO
|| to
->to_initval
== 0)
476 to
->to_initval
= NFS_DEF_UDP_TIMEO
* HZ
/ 10;
477 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
478 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
479 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
480 to
->to_exponential
= 1;
486 EXPORT_SYMBOL_GPL(nfs_init_timeout_values
);
489 * Create an RPC client handle
491 int nfs_create_rpc_client(struct nfs_client
*clp
,
492 const struct nfs_client_initdata
*cl_init
,
493 rpc_authflavor_t flavor
)
495 struct rpc_clnt
*clnt
= NULL
;
496 struct rpc_create_args args
= {
498 .protocol
= clp
->cl_proto
,
499 .nconnect
= clp
->cl_nconnect
,
500 .address
= (struct sockaddr
*)&clp
->cl_addr
,
501 .addrsize
= clp
->cl_addrlen
,
502 .timeout
= cl_init
->timeparms
,
503 .servername
= clp
->cl_hostname
,
504 .nodename
= cl_init
->nodename
,
505 .program
= &nfs_program
,
506 .version
= clp
->rpc_ops
->version
,
507 .authflavor
= flavor
,
508 .cred
= cl_init
->cred
,
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
;
520 if (!IS_ERR(clp
->cl_rpcclient
))
523 clnt
= rpc_create(&args
);
525 dprintk("%s: cannot create RPC client. Error = %ld\n",
526 __func__
, PTR_ERR(clnt
));
527 return PTR_ERR(clnt
);
530 clnt
->cl_principal
= clp
->cl_principal
;
531 clp
->cl_rpcclient
= clnt
;
534 EXPORT_SYMBOL_GPL(nfs_create_rpc_client
);
537 * Version 2 or 3 client destruction
539 static void nfs_destroy_server(struct nfs_server
*server
)
541 if (server
->nlm_host
)
542 nlmclnt_done(server
->nlm_host
);
546 * Version 2 or 3 lockd setup
548 static int nfs_start_lockd(struct nfs_server
*server
)
550 struct nlm_host
*host
;
551 struct nfs_client
*clp
= server
->nfs_client
;
552 struct nlmclnt_initdata nlm_init
= {
553 .hostname
= clp
->cl_hostname
,
554 .address
= (struct sockaddr
*)&clp
->cl_addr
,
555 .addrlen
= clp
->cl_addrlen
,
556 .nfs_version
= clp
->rpc_ops
->version
,
557 .noresvport
= server
->flags
& NFS_MOUNT_NORESVPORT
?
560 .nlmclnt_ops
= clp
->cl_nfs_mod
->rpc_ops
->nlmclnt_ops
,
561 .cred
= current_cred(),
564 if (nlm_init
.nfs_version
> 3)
566 if ((server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) &&
567 (server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
570 switch (clp
->cl_proto
) {
572 nlm_init
.protocol
= IPPROTO_TCP
;
574 case XPRT_TRANSPORT_UDP
:
575 nlm_init
.protocol
= IPPROTO_UDP
;
578 host
= nlmclnt_init(&nlm_init
);
580 return PTR_ERR(host
);
582 server
->nlm_host
= host
;
583 server
->destroy
= nfs_destroy_server
;
588 * Create a general RPC client
590 int nfs_init_server_rpcclient(struct nfs_server
*server
,
591 const struct rpc_timeout
*timeo
,
592 rpc_authflavor_t pseudoflavour
)
594 struct nfs_client
*clp
= server
->nfs_client
;
596 server
->client
= rpc_clone_client_set_auth(clp
->cl_rpcclient
,
598 if (IS_ERR(server
->client
)) {
599 dprintk("%s: couldn't create rpc_client!\n", __func__
);
600 return PTR_ERR(server
->client
);
603 memcpy(&server
->client
->cl_timeout_default
,
605 sizeof(server
->client
->cl_timeout_default
));
606 server
->client
->cl_timeout
= &server
->client
->cl_timeout_default
;
607 server
->client
->cl_softrtry
= 0;
608 if (server
->flags
& NFS_MOUNT_SOFTERR
)
609 server
->client
->cl_softerr
= 1;
610 if (server
->flags
& NFS_MOUNT_SOFT
)
611 server
->client
->cl_softrtry
= 1;
615 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient
);
618 * nfs_init_client - Initialise an NFS2 or NFS3 client
620 * @clp: nfs_client to initialise
621 * @cl_init: Initialisation parameters
623 * Returns pointer to an NFS client, or an ERR_PTR value.
625 struct nfs_client
*nfs_init_client(struct nfs_client
*clp
,
626 const struct nfs_client_initdata
*cl_init
)
630 /* the client is already initialised */
631 if (clp
->cl_cons_state
== NFS_CS_READY
)
635 * Create a client RPC handle for doing FSSTAT with UNIX auth only
636 * - RFC 2623, sec 2.3.2
638 error
= nfs_create_rpc_client(clp
, cl_init
, RPC_AUTH_UNIX
);
639 nfs_mark_client_ready(clp
, error
== 0 ? NFS_CS_READY
: error
);
642 clp
= ERR_PTR(error
);
646 EXPORT_SYMBOL_GPL(nfs_init_client
);
649 * Create a version 2 or 3 client
651 static int nfs_init_server(struct nfs_server
*server
,
652 const struct nfs_parsed_mount_data
*data
,
653 struct nfs_subversion
*nfs_mod
)
655 struct rpc_timeout timeparms
;
656 struct nfs_client_initdata cl_init
= {
657 .hostname
= data
->nfs_server
.hostname
,
658 .addr
= (const struct sockaddr
*)&data
->nfs_server
.address
,
659 .addrlen
= data
->nfs_server
.addrlen
,
661 .proto
= data
->nfs_server
.protocol
,
663 .timeparms
= &timeparms
,
664 .cred
= server
->cred
,
665 .nconnect
= data
->nfs_server
.nconnect
,
667 struct nfs_client
*clp
;
670 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
671 data
->timeo
, data
->retrans
);
672 if (data
->flags
& NFS_MOUNT_NORESVPORT
)
673 set_bit(NFS_CS_NORESVPORT
, &cl_init
.init_flags
);
675 /* Allocate or find a client reference we can use */
676 clp
= nfs_get_client(&cl_init
);
680 server
->nfs_client
= clp
;
682 /* Initialise the client representation from the mount data */
683 server
->flags
= data
->flags
;
684 server
->options
= data
->options
;
685 server
->caps
|= NFS_CAP_HARDLINKS
|NFS_CAP_SYMLINKS
|NFS_CAP_FILEID
|
686 NFS_CAP_MODE
|NFS_CAP_NLINK
|NFS_CAP_OWNER
|NFS_CAP_OWNER_GROUP
|
687 NFS_CAP_ATIME
|NFS_CAP_CTIME
|NFS_CAP_MTIME
;
690 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
692 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
694 server
->acregmin
= data
->acregmin
* HZ
;
695 server
->acregmax
= data
->acregmax
* HZ
;
696 server
->acdirmin
= data
->acdirmin
* HZ
;
697 server
->acdirmax
= data
->acdirmax
* HZ
;
699 /* Start lockd here, before we might error out */
700 error
= nfs_start_lockd(server
);
704 server
->port
= data
->nfs_server
.port
;
705 server
->auth_info
= data
->auth_info
;
707 error
= nfs_init_server_rpcclient(server
, &timeparms
,
708 data
->selected_flavor
);
712 /* Preserve the values of mount_server-related mount options */
713 if (data
->mount_server
.addrlen
) {
714 memcpy(&server
->mountd_address
, &data
->mount_server
.address
,
715 data
->mount_server
.addrlen
);
716 server
->mountd_addrlen
= data
->mount_server
.addrlen
;
718 server
->mountd_version
= data
->mount_server
.version
;
719 server
->mountd_port
= data
->mount_server
.port
;
720 server
->mountd_protocol
= data
->mount_server
.protocol
;
722 server
->namelen
= data
->namlen
;
726 server
->nfs_client
= NULL
;
732 * Load up the server record from information gained in an fsinfo record
734 static void nfs_server_set_fsinfo(struct nfs_server
*server
,
735 struct nfs_fsinfo
*fsinfo
)
737 unsigned long max_rpc_payload
;
739 /* Work out a lot of parameters */
740 if (server
->rsize
== 0)
741 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
742 if (server
->wsize
== 0)
743 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
745 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
746 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
747 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
748 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
750 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
751 if (server
->rsize
> max_rpc_payload
)
752 server
->rsize
= max_rpc_payload
;
753 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
754 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
755 server
->rpages
= (server
->rsize
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
757 if (server
->wsize
> max_rpc_payload
)
758 server
->wsize
= max_rpc_payload
;
759 if (server
->wsize
> NFS_MAX_FILE_IO_SIZE
)
760 server
->wsize
= NFS_MAX_FILE_IO_SIZE
;
761 server
->wpages
= (server
->wsize
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
763 server
->wtmult
= nfs_block_bits(fsinfo
->wtmult
, NULL
);
765 server
->dtsize
= nfs_block_size(fsinfo
->dtpref
, NULL
);
766 if (server
->dtsize
> PAGE_SIZE
* NFS_MAX_READDIR_PAGES
)
767 server
->dtsize
= PAGE_SIZE
* NFS_MAX_READDIR_PAGES
;
768 if (server
->dtsize
> server
->rsize
)
769 server
->dtsize
= server
->rsize
;
771 if (server
->flags
& NFS_MOUNT_NOAC
) {
772 server
->acregmin
= server
->acregmax
= 0;
773 server
->acdirmin
= server
->acdirmax
= 0;
776 server
->maxfilesize
= fsinfo
->maxfilesize
;
778 server
->time_delta
= fsinfo
->time_delta
;
780 server
->clone_blksize
= fsinfo
->clone_blksize
;
781 /* We're airborne Set socket buffersize */
782 rpc_setbufsize(server
->client
, server
->wsize
+ 100, server
->rsize
+ 100);
786 * Probe filesystem information, including the FSID on v2/v3
788 int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*mntfh
, struct nfs_fattr
*fattr
)
790 struct nfs_fsinfo fsinfo
;
791 struct nfs_client
*clp
= server
->nfs_client
;
794 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
795 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
800 fsinfo
.fattr
= fattr
;
801 fsinfo
.nlayouttypes
= 0;
802 memset(fsinfo
.layouttype
, 0, sizeof(fsinfo
.layouttype
));
803 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
807 nfs_server_set_fsinfo(server
, &fsinfo
);
809 /* Get some general file system info */
810 if (server
->namelen
== 0) {
811 struct nfs_pathconf pathinfo
;
813 pathinfo
.fattr
= fattr
;
814 nfs_fattr_init(fattr
);
816 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
817 server
->namelen
= pathinfo
.max_namelen
;
822 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo
);
825 * Copy useful information when duplicating a server record
827 void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
829 target
->flags
= source
->flags
;
830 target
->rsize
= source
->rsize
;
831 target
->wsize
= source
->wsize
;
832 target
->acregmin
= source
->acregmin
;
833 target
->acregmax
= source
->acregmax
;
834 target
->acdirmin
= source
->acdirmin
;
835 target
->acdirmax
= source
->acdirmax
;
836 target
->caps
= source
->caps
;
837 target
->options
= source
->options
;
838 target
->auth_info
= source
->auth_info
;
839 target
->port
= source
->port
;
841 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata
);
843 void nfs_server_insert_lists(struct nfs_server
*server
)
845 struct nfs_client
*clp
= server
->nfs_client
;
846 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
848 spin_lock(&nn
->nfs_client_lock
);
849 list_add_tail_rcu(&server
->client_link
, &clp
->cl_superblocks
);
850 list_add_tail(&server
->master_link
, &nn
->nfs_volume_list
);
851 clear_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
852 spin_unlock(&nn
->nfs_client_lock
);
855 EXPORT_SYMBOL_GPL(nfs_server_insert_lists
);
857 void nfs_server_remove_lists(struct nfs_server
*server
)
859 struct nfs_client
*clp
= server
->nfs_client
;
864 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
865 spin_lock(&nn
->nfs_client_lock
);
866 list_del_rcu(&server
->client_link
);
867 if (list_empty(&clp
->cl_superblocks
))
868 set_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
869 list_del(&server
->master_link
);
870 spin_unlock(&nn
->nfs_client_lock
);
874 EXPORT_SYMBOL_GPL(nfs_server_remove_lists
);
877 * Allocate and initialise a server record
879 struct nfs_server
*nfs_alloc_server(void)
881 struct nfs_server
*server
;
883 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
887 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
889 /* Zero out the NFS state stuff */
890 INIT_LIST_HEAD(&server
->client_link
);
891 INIT_LIST_HEAD(&server
->master_link
);
892 INIT_LIST_HEAD(&server
->delegations
);
893 INIT_LIST_HEAD(&server
->layouts
);
894 INIT_LIST_HEAD(&server
->state_owners_lru
);
895 INIT_LIST_HEAD(&server
->ss_copies
);
897 atomic_set(&server
->active
, 0);
899 server
->io_stats
= nfs_alloc_iostats();
900 if (!server
->io_stats
) {
905 ida_init(&server
->openowner_id
);
906 ida_init(&server
->lockowner_id
);
907 pnfs_init_server(server
);
908 rpc_init_wait_queue(&server
->uoc_rpcwaitq
, "NFS UOC");
912 EXPORT_SYMBOL_GPL(nfs_alloc_server
);
915 * Free up a server record
917 void nfs_free_server(struct nfs_server
*server
)
919 nfs_server_remove_lists(server
);
921 if (server
->destroy
!= NULL
)
922 server
->destroy(server
);
924 if (!IS_ERR(server
->client_acl
))
925 rpc_shutdown_client(server
->client_acl
);
926 if (!IS_ERR(server
->client
))
927 rpc_shutdown_client(server
->client
);
929 nfs_put_client(server
->nfs_client
);
931 ida_destroy(&server
->lockowner_id
);
932 ida_destroy(&server
->openowner_id
);
933 nfs_free_iostats(server
->io_stats
);
934 put_cred(server
->cred
);
936 nfs_release_automount_timer();
938 EXPORT_SYMBOL_GPL(nfs_free_server
);
941 * Create a version 2 or 3 volume record
942 * - keyed on server and FSID
944 struct nfs_server
*nfs_create_server(struct nfs_mount_info
*mount_info
,
945 struct nfs_subversion
*nfs_mod
)
947 struct nfs_server
*server
;
948 struct nfs_fattr
*fattr
;
951 server
= nfs_alloc_server();
953 return ERR_PTR(-ENOMEM
);
955 server
->cred
= get_cred(current_cred());
958 fattr
= nfs_alloc_fattr();
962 /* Get a client representation */
963 error
= nfs_init_server(server
, mount_info
->parsed
, nfs_mod
);
967 /* Probe the root fh to retrieve its FSID */
968 error
= nfs_probe_fsinfo(server
, mount_info
->mntfh
, fattr
);
971 if (server
->nfs_client
->rpc_ops
->version
== 3) {
972 if (server
->namelen
== 0 || server
->namelen
> NFS3_MAXNAMLEN
)
973 server
->namelen
= NFS3_MAXNAMLEN
;
974 if (!(mount_info
->parsed
->flags
& NFS_MOUNT_NORDIRPLUS
))
975 server
->caps
|= NFS_CAP_READDIRPLUS
;
977 if (server
->namelen
== 0 || server
->namelen
> NFS2_MAXNAMLEN
)
978 server
->namelen
= NFS2_MAXNAMLEN
;
981 if (!(fattr
->valid
& NFS_ATTR_FATTR
)) {
982 error
= nfs_mod
->rpc_ops
->getattr(server
, mount_info
->mntfh
,
985 dprintk("nfs_create_server: getattr error = %d\n", -error
);
989 memcpy(&server
->fsid
, &fattr
->fsid
, sizeof(server
->fsid
));
991 dprintk("Server FSID: %llx:%llx\n",
992 (unsigned long long) server
->fsid
.major
,
993 (unsigned long long) server
->fsid
.minor
);
995 nfs_server_insert_lists(server
);
996 server
->mount_time
= jiffies
;
997 nfs_free_fattr(fattr
);
1001 nfs_free_fattr(fattr
);
1002 nfs_free_server(server
);
1003 return ERR_PTR(error
);
1005 EXPORT_SYMBOL_GPL(nfs_create_server
);
1008 * Clone an NFS2, NFS3 or NFS4 server record
1010 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
1012 struct nfs_fattr
*fattr
,
1013 rpc_authflavor_t flavor
)
1015 struct nfs_server
*server
;
1016 struct nfs_fattr
*fattr_fsinfo
;
1019 server
= nfs_alloc_server();
1021 return ERR_PTR(-ENOMEM
);
1023 server
->cred
= get_cred(source
->cred
);
1026 fattr_fsinfo
= nfs_alloc_fattr();
1027 if (fattr_fsinfo
== NULL
)
1028 goto out_free_server
;
1030 /* Copy data from the source */
1031 server
->nfs_client
= source
->nfs_client
;
1032 server
->destroy
= source
->destroy
;
1033 refcount_inc(&server
->nfs_client
->cl_count
);
1034 nfs_server_copy_userdata(server
, source
);
1036 server
->fsid
= fattr
->fsid
;
1038 error
= nfs_init_server_rpcclient(server
,
1039 source
->client
->cl_timeout
,
1042 goto out_free_server
;
1044 /* probe the filesystem info for this server filesystem */
1045 error
= nfs_probe_fsinfo(server
, fh
, fattr_fsinfo
);
1047 goto out_free_server
;
1049 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1050 server
->namelen
= NFS4_MAXNAMLEN
;
1052 error
= nfs_start_lockd(server
);
1054 goto out_free_server
;
1056 nfs_server_insert_lists(server
);
1057 server
->mount_time
= jiffies
;
1059 nfs_free_fattr(fattr_fsinfo
);
1063 nfs_free_fattr(fattr_fsinfo
);
1064 nfs_free_server(server
);
1065 return ERR_PTR(error
);
1067 EXPORT_SYMBOL_GPL(nfs_clone_server
);
1069 void nfs_clients_init(struct net
*net
)
1071 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1073 INIT_LIST_HEAD(&nn
->nfs_client_list
);
1074 INIT_LIST_HEAD(&nn
->nfs_volume_list
);
1075 #if IS_ENABLED(CONFIG_NFS_V4)
1076 idr_init(&nn
->cb_ident_idr
);
1078 spin_lock_init(&nn
->nfs_client_lock
);
1079 nn
->boot_time
= ktime_get_real();
1081 nfs_netns_sysfs_setup(nn
, net
);
1084 void nfs_clients_exit(struct net
*net
)
1086 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1088 nfs_netns_sysfs_destroy(nn
);
1089 nfs_cleanup_cb_ident_idr(net
);
1090 WARN_ON_ONCE(!list_empty(&nn
->nfs_client_list
));
1091 WARN_ON_ONCE(!list_empty(&nn
->nfs_volume_list
));
1094 #ifdef CONFIG_PROC_FS
1095 static void *nfs_server_list_start(struct seq_file
*p
, loff_t
*pos
);
1096 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1097 static void nfs_server_list_stop(struct seq_file
*p
, void *v
);
1098 static int nfs_server_list_show(struct seq_file
*m
, void *v
);
1100 static const struct seq_operations nfs_server_list_ops
= {
1101 .start
= nfs_server_list_start
,
1102 .next
= nfs_server_list_next
,
1103 .stop
= nfs_server_list_stop
,
1104 .show
= nfs_server_list_show
,
1107 static void *nfs_volume_list_start(struct seq_file
*p
, loff_t
*pos
);
1108 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1109 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
);
1110 static int nfs_volume_list_show(struct seq_file
*m
, void *v
);
1112 static const struct seq_operations nfs_volume_list_ops
= {
1113 .start
= nfs_volume_list_start
,
1114 .next
= nfs_volume_list_next
,
1115 .stop
= nfs_volume_list_stop
,
1116 .show
= nfs_volume_list_show
,
1120 * set up the iterator to start reading from the server list and return the first item
1122 static void *nfs_server_list_start(struct seq_file
*m
, loff_t
*_pos
)
1123 __acquires(&nn
->nfs_client_lock
)
1125 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1127 /* lock the list against modification */
1128 spin_lock(&nn
->nfs_client_lock
);
1129 return seq_list_start_head(&nn
->nfs_client_list
, *_pos
);
1133 * move to next server
1135 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1137 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1139 return seq_list_next(v
, &nn
->nfs_client_list
, pos
);
1143 * clean up after reading from the transports list
1145 static void nfs_server_list_stop(struct seq_file
*p
, void *v
)
1146 __releases(&nn
->nfs_client_lock
)
1148 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1150 spin_unlock(&nn
->nfs_client_lock
);
1154 * display a header line followed by a load of call lines
1156 static int nfs_server_list_show(struct seq_file
*m
, void *v
)
1158 struct nfs_client
*clp
;
1159 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1161 /* display header on line 1 */
1162 if (v
== &nn
->nfs_client_list
) {
1163 seq_puts(m
, "NV SERVER PORT USE HOSTNAME\n");
1167 /* display one transport per line on subsequent lines */
1168 clp
= list_entry(v
, struct nfs_client
, cl_share_link
);
1170 /* Check if the client is initialized */
1171 if (clp
->cl_cons_state
!= NFS_CS_READY
)
1175 seq_printf(m
, "v%u %s %s %3d %s\n",
1176 clp
->rpc_ops
->version
,
1177 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1178 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1179 refcount_read(&clp
->cl_count
),
1187 * set up the iterator to start reading from the volume list and return the first item
1189 static void *nfs_volume_list_start(struct seq_file
*m
, loff_t
*_pos
)
1190 __acquires(&nn
->nfs_client_lock
)
1192 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1194 /* lock the list against modification */
1195 spin_lock(&nn
->nfs_client_lock
);
1196 return seq_list_start_head(&nn
->nfs_volume_list
, *_pos
);
1200 * move to next volume
1202 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1204 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1206 return seq_list_next(v
, &nn
->nfs_volume_list
, pos
);
1210 * clean up after reading from the transports list
1212 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
)
1213 __releases(&nn
->nfs_client_lock
)
1215 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1217 spin_unlock(&nn
->nfs_client_lock
);
1221 * display a header line followed by a load of call lines
1223 static int nfs_volume_list_show(struct seq_file
*m
, void *v
)
1225 struct nfs_server
*server
;
1226 struct nfs_client
*clp
;
1227 char dev
[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1228 char fsid
[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1229 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1231 /* display header on line 1 */
1232 if (v
== &nn
->nfs_volume_list
) {
1233 seq_puts(m
, "NV SERVER PORT DEV FSID"
1237 /* display one transport per line on subsequent lines */
1238 server
= list_entry(v
, struct nfs_server
, master_link
);
1239 clp
= server
->nfs_client
;
1241 snprintf(dev
, sizeof(dev
), "%u:%u",
1242 MAJOR(server
->s_dev
), MINOR(server
->s_dev
));
1244 snprintf(fsid
, sizeof(fsid
), "%llx:%llx",
1245 (unsigned long long) server
->fsid
.major
,
1246 (unsigned long long) server
->fsid
.minor
);
1249 seq_printf(m
, "v%u %s %s %-12s %-33s %s\n",
1250 clp
->rpc_ops
->version
,
1251 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1252 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1255 nfs_server_fscache_state(server
));
1261 int nfs_fs_proc_net_init(struct net
*net
)
1263 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1264 struct proc_dir_entry
*p
;
1266 nn
->proc_nfsfs
= proc_net_mkdir(net
, "nfsfs", net
->proc_net
);
1267 if (!nn
->proc_nfsfs
)
1270 /* a file of servers with which we're dealing */
1271 p
= proc_create_net("servers", S_IFREG
|S_IRUGO
, nn
->proc_nfsfs
,
1272 &nfs_server_list_ops
, sizeof(struct seq_net_private
));
1276 /* a file of volumes that we have mounted */
1277 p
= proc_create_net("volumes", S_IFREG
|S_IRUGO
, nn
->proc_nfsfs
,
1278 &nfs_volume_list_ops
, sizeof(struct seq_net_private
));
1284 remove_proc_subtree("nfsfs", net
->proc_net
);
1289 void nfs_fs_proc_net_exit(struct net
*net
)
1291 remove_proc_subtree("nfsfs", net
->proc_net
);
1295 * initialise the /proc/fs/nfsfs/ directory
1297 int __init
nfs_fs_proc_init(void)
1299 if (!proc_mkdir("fs/nfsfs", NULL
))
1302 /* a file of servers with which we're dealing */
1303 if (!proc_symlink("fs/nfsfs/servers", NULL
, "../../net/nfsfs/servers"))
1306 /* a file of volumes that we have mounted */
1307 if (!proc_symlink("fs/nfsfs/volumes", NULL
, "../../net/nfsfs/volumes"))
1312 remove_proc_subtree("fs/nfsfs", NULL
);
1318 * clean up the /proc/fs/nfsfs/ directory
1320 void nfs_fs_proc_exit(void)
1322 remove_proc_subtree("fs/nfsfs", NULL
);
1325 #endif /* CONFIG_PROC_FS */