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>
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>
41 #include <linux/nfs_xdr.h>
42 #include <linux/sunrpc/bc_xprt.h>
43 #include <linux/nsproxy.h>
44 #include <linux/pid_namespace.h>
49 #include "delegation.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
);
67 static const struct rpc_version
*nfs_version
[5] = {
73 const struct rpc_program nfs_program
= {
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
);
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
);
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
);
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
;
156 if ((clp
= kzalloc(sizeof(*clp
), GFP_KERNEL
)) == NULL
)
159 clp
->cl_nfs_mod
= cl_init
->nfs_mod
;
160 if (!try_module_get(clp
->cl_nfs_mod
->owner
))
163 clp
->rpc_ops
= clp
->cl_nfs_mod
->rpc_ops
;
165 refcount_set(&clp
->cl_count
, 1);
166 clp
->cl_cons_state
= NFS_CS_INITING
;
168 memcpy(&clp
->cl_addr
, cl_init
->addr
, cl_init
->addrlen
);
169 clp
->cl_addrlen
= cl_init
->addrlen
;
171 if (cl_init
->hostname
) {
173 clp
->cl_hostname
= kstrdup(cl_init
->hostname
, GFP_KERNEL
);
174 if (!clp
->cl_hostname
)
178 INIT_LIST_HEAD(&clp
->cl_superblocks
);
179 clp
->cl_rpcclient
= ERR_PTR(-EINVAL
);
181 clp
->cl_proto
= cl_init
->proto
;
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 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 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
);
289 list_for_each_entry(clp
, &nn
->nfs_client_list
, cl_share_link
) {
290 const struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
291 /* Don't match clients that failed to initialise properly */
292 if (clp
->cl_cons_state
< 0)
295 /* If a client is still initializing then we need to wait */
296 if (clp
->cl_cons_state
> NFS_CS_READY
) {
297 refcount_inc(&clp
->cl_count
);
298 spin_unlock(&nn
->nfs_client_lock
);
299 nfs_wait_client_init_complete(clp
);
301 spin_lock(&nn
->nfs_client_lock
);
305 /* Different NFS versions cannot share the same nfs_client */
306 if (clp
->rpc_ops
!= data
->nfs_mod
->rpc_ops
)
309 if (clp
->cl_proto
!= data
->proto
)
311 /* Match nfsv4 minorversion */
312 if (clp
->cl_minorversion
!= data
->minorversion
)
314 /* Match the full socket address */
315 if (!rpc_cmp_addr_port(sap
, clap
))
316 /* Match all xprt_switch full socket addresses */
317 if (IS_ERR(clp
->cl_rpcclient
) ||
318 !rpc_clnt_xprt_switch_has_addr(clp
->cl_rpcclient
,
322 refcount_inc(&clp
->cl_count
);
329 * Return true if @clp is done initializing, false if still working on it.
331 * Use nfs_client_init_status to check if it was successful.
333 bool nfs_client_init_is_complete(const struct nfs_client
*clp
)
335 return clp
->cl_cons_state
<= NFS_CS_READY
;
337 EXPORT_SYMBOL_GPL(nfs_client_init_is_complete
);
340 * Return 0 if @clp was successfully initialized, -errno otherwise.
342 * This must be called *after* nfs_client_init_is_complete() returns true,
343 * otherwise it will pop WARN_ON_ONCE and return -EINVAL
345 int nfs_client_init_status(const struct nfs_client
*clp
)
347 /* called without checking nfs_client_init_is_complete */
348 if (clp
->cl_cons_state
> NFS_CS_READY
) {
352 return clp
->cl_cons_state
;
354 EXPORT_SYMBOL_GPL(nfs_client_init_status
);
356 int nfs_wait_client_init_complete(const struct nfs_client
*clp
)
358 return wait_event_killable(nfs_client_active_wq
,
359 nfs_client_init_is_complete(clp
));
361 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete
);
364 * Found an existing client. Make sure it's ready before returning.
366 static struct nfs_client
*
367 nfs_found_client(const struct nfs_client_initdata
*cl_init
,
368 struct nfs_client
*clp
)
372 error
= nfs_wait_client_init_complete(clp
);
375 return ERR_PTR(-ERESTARTSYS
);
378 if (clp
->cl_cons_state
< NFS_CS_READY
) {
379 error
= clp
->cl_cons_state
;
381 return ERR_PTR(error
);
389 * Look up a client by IP address and protocol version
390 * - creates a new record if one doesn't yet exist
392 struct nfs_client
*nfs_get_client(const struct nfs_client_initdata
*cl_init
)
394 struct nfs_client
*clp
, *new = NULL
;
395 struct nfs_net
*nn
= net_generic(cl_init
->net
, nfs_net_id
);
396 const struct nfs_rpc_ops
*rpc_ops
= cl_init
->nfs_mod
->rpc_ops
;
398 if (cl_init
->hostname
== NULL
) {
403 /* see if the client already exists */
405 spin_lock(&nn
->nfs_client_lock
);
407 clp
= nfs_match_client(cl_init
);
409 spin_unlock(&nn
->nfs_client_lock
);
411 new->rpc_ops
->free_client(new);
412 return nfs_found_client(cl_init
, clp
);
415 list_add_tail(&new->cl_share_link
,
416 &nn
->nfs_client_list
);
417 spin_unlock(&nn
->nfs_client_lock
);
418 new->cl_flags
= cl_init
->init_flags
;
419 return rpc_ops
->init_client(new, cl_init
);
422 spin_unlock(&nn
->nfs_client_lock
);
424 new = rpc_ops
->alloc_client(cl_init
);
425 } while (!IS_ERR(new));
429 EXPORT_SYMBOL_GPL(nfs_get_client
);
432 * Mark a server as ready or failed
434 void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
437 clp
->cl_cons_state
= state
;
438 wake_up_all(&nfs_client_active_wq
);
440 EXPORT_SYMBOL_GPL(nfs_mark_client_ready
);
443 * Initialise the timeout values for a connection
445 void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
446 int timeo
, int retrans
)
448 to
->to_initval
= timeo
* HZ
/ 10;
449 to
->to_retries
= retrans
;
452 case XPRT_TRANSPORT_TCP
:
453 case XPRT_TRANSPORT_RDMA
:
454 if (retrans
== NFS_UNSPEC_RETRANS
)
455 to
->to_retries
= NFS_DEF_TCP_RETRANS
;
456 if (timeo
== NFS_UNSPEC_TIMEO
|| to
->to_retries
== 0)
457 to
->to_initval
= NFS_DEF_TCP_TIMEO
* HZ
/ 10;
458 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
459 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
460 to
->to_increment
= to
->to_initval
;
461 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
462 if (to
->to_maxval
> NFS_MAX_TCP_TIMEOUT
)
463 to
->to_maxval
= NFS_MAX_TCP_TIMEOUT
;
464 if (to
->to_maxval
< to
->to_initval
)
465 to
->to_maxval
= to
->to_initval
;
466 to
->to_exponential
= 0;
468 case XPRT_TRANSPORT_UDP
:
469 if (retrans
== NFS_UNSPEC_RETRANS
)
470 to
->to_retries
= NFS_DEF_UDP_RETRANS
;
471 if (timeo
== NFS_UNSPEC_TIMEO
|| to
->to_initval
== 0)
472 to
->to_initval
= NFS_DEF_UDP_TIMEO
* HZ
/ 10;
473 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
474 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
475 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
476 to
->to_exponential
= 1;
482 EXPORT_SYMBOL_GPL(nfs_init_timeout_values
);
485 * Create an RPC client handle
487 int nfs_create_rpc_client(struct nfs_client
*clp
,
488 const struct nfs_client_initdata
*cl_init
,
489 rpc_authflavor_t flavor
)
491 struct rpc_clnt
*clnt
= NULL
;
492 struct rpc_create_args args
= {
494 .protocol
= clp
->cl_proto
,
495 .address
= (struct sockaddr
*)&clp
->cl_addr
,
496 .addrsize
= clp
->cl_addrlen
,
497 .timeout
= cl_init
->timeparms
,
498 .servername
= clp
->cl_hostname
,
499 .nodename
= cl_init
->nodename
,
500 .program
= &nfs_program
,
501 .version
= clp
->rpc_ops
->version
,
502 .authflavor
= flavor
,
505 if (test_bit(NFS_CS_DISCRTRY
, &clp
->cl_flags
))
506 args
.flags
|= RPC_CLNT_CREATE_DISCRTRY
;
507 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT
, &clp
->cl_flags
))
508 args
.flags
|= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT
;
509 if (test_bit(NFS_CS_NORESVPORT
, &clp
->cl_flags
))
510 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
511 if (test_bit(NFS_CS_INFINITE_SLOTS
, &clp
->cl_flags
))
512 args
.flags
|= RPC_CLNT_CREATE_INFINITE_SLOTS
;
514 if (!IS_ERR(clp
->cl_rpcclient
))
517 clnt
= rpc_create(&args
);
519 dprintk("%s: cannot create RPC client. Error = %ld\n",
520 __func__
, PTR_ERR(clnt
));
521 return PTR_ERR(clnt
);
524 clnt
->cl_principal
= clp
->cl_principal
;
525 clp
->cl_rpcclient
= clnt
;
528 EXPORT_SYMBOL_GPL(nfs_create_rpc_client
);
531 * Version 2 or 3 client destruction
533 static void nfs_destroy_server(struct nfs_server
*server
)
535 if (server
->nlm_host
)
536 nlmclnt_done(server
->nlm_host
);
540 * Version 2 or 3 lockd setup
542 static int nfs_start_lockd(struct nfs_server
*server
)
544 struct nlm_host
*host
;
545 struct nfs_client
*clp
= server
->nfs_client
;
546 struct nlmclnt_initdata nlm_init
= {
547 .hostname
= clp
->cl_hostname
,
548 .address
= (struct sockaddr
*)&clp
->cl_addr
,
549 .addrlen
= clp
->cl_addrlen
,
550 .nfs_version
= clp
->rpc_ops
->version
,
551 .noresvport
= server
->flags
& NFS_MOUNT_NORESVPORT
?
554 .nlmclnt_ops
= clp
->cl_nfs_mod
->rpc_ops
->nlmclnt_ops
,
557 if (nlm_init
.nfs_version
> 3)
559 if ((server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) &&
560 (server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
563 switch (clp
->cl_proto
) {
565 nlm_init
.protocol
= IPPROTO_TCP
;
567 case XPRT_TRANSPORT_UDP
:
568 nlm_init
.protocol
= IPPROTO_UDP
;
571 host
= nlmclnt_init(&nlm_init
);
573 return PTR_ERR(host
);
575 server
->nlm_host
= host
;
576 server
->destroy
= nfs_destroy_server
;
581 * Create a general RPC client
583 int nfs_init_server_rpcclient(struct nfs_server
*server
,
584 const struct rpc_timeout
*timeo
,
585 rpc_authflavor_t pseudoflavour
)
587 struct nfs_client
*clp
= server
->nfs_client
;
589 server
->client
= rpc_clone_client_set_auth(clp
->cl_rpcclient
,
591 if (IS_ERR(server
->client
)) {
592 dprintk("%s: couldn't create rpc_client!\n", __func__
);
593 return PTR_ERR(server
->client
);
596 memcpy(&server
->client
->cl_timeout_default
,
598 sizeof(server
->client
->cl_timeout_default
));
599 server
->client
->cl_timeout
= &server
->client
->cl_timeout_default
;
600 server
->client
->cl_softrtry
= 0;
601 if (server
->flags
& NFS_MOUNT_SOFT
)
602 server
->client
->cl_softrtry
= 1;
606 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient
);
609 * nfs_init_client - Initialise an NFS2 or NFS3 client
611 * @clp: nfs_client to initialise
612 * @cl_init: Initialisation parameters
614 * Returns pointer to an NFS client, or an ERR_PTR value.
616 struct nfs_client
*nfs_init_client(struct nfs_client
*clp
,
617 const struct nfs_client_initdata
*cl_init
)
621 /* the client is already initialised */
622 if (clp
->cl_cons_state
== NFS_CS_READY
)
626 * Create a client RPC handle for doing FSSTAT with UNIX auth only
627 * - RFC 2623, sec 2.3.2
629 error
= nfs_create_rpc_client(clp
, cl_init
, RPC_AUTH_UNIX
);
630 nfs_mark_client_ready(clp
, error
== 0 ? NFS_CS_READY
: error
);
633 clp
= ERR_PTR(error
);
637 EXPORT_SYMBOL_GPL(nfs_init_client
);
640 * Create a version 2 or 3 client
642 static int nfs_init_server(struct nfs_server
*server
,
643 const struct nfs_parsed_mount_data
*data
,
644 struct nfs_subversion
*nfs_mod
)
646 struct rpc_timeout timeparms
;
647 struct nfs_client_initdata cl_init
= {
648 .hostname
= data
->nfs_server
.hostname
,
649 .addr
= (const struct sockaddr
*)&data
->nfs_server
.address
,
650 .addrlen
= data
->nfs_server
.addrlen
,
652 .proto
= data
->nfs_server
.protocol
,
654 .timeparms
= &timeparms
,
656 struct nfs_client
*clp
;
659 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
660 data
->timeo
, data
->retrans
);
661 if (data
->flags
& NFS_MOUNT_NORESVPORT
)
662 set_bit(NFS_CS_NORESVPORT
, &cl_init
.init_flags
);
664 /* Allocate or find a client reference we can use */
665 clp
= nfs_get_client(&cl_init
);
669 server
->nfs_client
= clp
;
671 /* Initialise the client representation from the mount data */
672 server
->flags
= data
->flags
;
673 server
->options
= data
->options
;
674 server
->caps
|= NFS_CAP_HARDLINKS
|NFS_CAP_SYMLINKS
|NFS_CAP_FILEID
|
675 NFS_CAP_MODE
|NFS_CAP_NLINK
|NFS_CAP_OWNER
|NFS_CAP_OWNER_GROUP
|
676 NFS_CAP_ATIME
|NFS_CAP_CTIME
|NFS_CAP_MTIME
;
679 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
681 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
683 server
->acregmin
= data
->acregmin
* HZ
;
684 server
->acregmax
= data
->acregmax
* HZ
;
685 server
->acdirmin
= data
->acdirmin
* HZ
;
686 server
->acdirmax
= data
->acdirmax
* HZ
;
688 /* Start lockd here, before we might error out */
689 error
= nfs_start_lockd(server
);
693 server
->port
= data
->nfs_server
.port
;
694 server
->auth_info
= data
->auth_info
;
696 error
= nfs_init_server_rpcclient(server
, &timeparms
,
697 data
->selected_flavor
);
701 /* Preserve the values of mount_server-related mount options */
702 if (data
->mount_server
.addrlen
) {
703 memcpy(&server
->mountd_address
, &data
->mount_server
.address
,
704 data
->mount_server
.addrlen
);
705 server
->mountd_addrlen
= data
->mount_server
.addrlen
;
707 server
->mountd_version
= data
->mount_server
.version
;
708 server
->mountd_port
= data
->mount_server
.port
;
709 server
->mountd_protocol
= data
->mount_server
.protocol
;
711 server
->namelen
= data
->namlen
;
715 server
->nfs_client
= NULL
;
721 * Load up the server record from information gained in an fsinfo record
723 static void nfs_server_set_fsinfo(struct nfs_server
*server
,
724 struct nfs_fsinfo
*fsinfo
)
726 unsigned long max_rpc_payload
;
728 /* Work out a lot of parameters */
729 if (server
->rsize
== 0)
730 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
731 if (server
->wsize
== 0)
732 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
734 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
735 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
736 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
737 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
739 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
740 if (server
->rsize
> max_rpc_payload
)
741 server
->rsize
= max_rpc_payload
;
742 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
743 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
744 server
->rpages
= (server
->rsize
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
746 if (server
->wsize
> max_rpc_payload
)
747 server
->wsize
= max_rpc_payload
;
748 if (server
->wsize
> NFS_MAX_FILE_IO_SIZE
)
749 server
->wsize
= NFS_MAX_FILE_IO_SIZE
;
750 server
->wpages
= (server
->wsize
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
752 server
->wtmult
= nfs_block_bits(fsinfo
->wtmult
, NULL
);
754 server
->dtsize
= nfs_block_size(fsinfo
->dtpref
, NULL
);
755 if (server
->dtsize
> PAGE_SIZE
* NFS_MAX_READDIR_PAGES
)
756 server
->dtsize
= PAGE_SIZE
* NFS_MAX_READDIR_PAGES
;
757 if (server
->dtsize
> server
->rsize
)
758 server
->dtsize
= server
->rsize
;
760 if (server
->flags
& NFS_MOUNT_NOAC
) {
761 server
->acregmin
= server
->acregmax
= 0;
762 server
->acdirmin
= server
->acdirmax
= 0;
765 server
->maxfilesize
= fsinfo
->maxfilesize
;
767 server
->time_delta
= fsinfo
->time_delta
;
769 server
->clone_blksize
= fsinfo
->clone_blksize
;
770 /* We're airborne Set socket buffersize */
771 rpc_setbufsize(server
->client
, server
->wsize
+ 100, server
->rsize
+ 100);
775 * Probe filesystem information, including the FSID on v2/v3
777 int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*mntfh
, struct nfs_fattr
*fattr
)
779 struct nfs_fsinfo fsinfo
;
780 struct nfs_client
*clp
= server
->nfs_client
;
783 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
784 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
789 fsinfo
.fattr
= fattr
;
790 fsinfo
.nlayouttypes
= 0;
791 memset(fsinfo
.layouttype
, 0, sizeof(fsinfo
.layouttype
));
792 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
796 nfs_server_set_fsinfo(server
, &fsinfo
);
798 /* Get some general file system info */
799 if (server
->namelen
== 0) {
800 struct nfs_pathconf pathinfo
;
802 pathinfo
.fattr
= fattr
;
803 nfs_fattr_init(fattr
);
805 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
806 server
->namelen
= pathinfo
.max_namelen
;
811 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo
);
814 * Copy useful information when duplicating a server record
816 void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
818 target
->flags
= source
->flags
;
819 target
->rsize
= source
->rsize
;
820 target
->wsize
= source
->wsize
;
821 target
->acregmin
= source
->acregmin
;
822 target
->acregmax
= source
->acregmax
;
823 target
->acdirmin
= source
->acdirmin
;
824 target
->acdirmax
= source
->acdirmax
;
825 target
->caps
= source
->caps
;
826 target
->options
= source
->options
;
827 target
->auth_info
= source
->auth_info
;
828 target
->port
= source
->port
;
830 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata
);
832 void nfs_server_insert_lists(struct nfs_server
*server
)
834 struct nfs_client
*clp
= server
->nfs_client
;
835 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
837 spin_lock(&nn
->nfs_client_lock
);
838 list_add_tail_rcu(&server
->client_link
, &clp
->cl_superblocks
);
839 list_add_tail(&server
->master_link
, &nn
->nfs_volume_list
);
840 clear_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
841 spin_unlock(&nn
->nfs_client_lock
);
844 EXPORT_SYMBOL_GPL(nfs_server_insert_lists
);
846 void nfs_server_remove_lists(struct nfs_server
*server
)
848 struct nfs_client
*clp
= server
->nfs_client
;
853 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
854 spin_lock(&nn
->nfs_client_lock
);
855 list_del_rcu(&server
->client_link
);
856 if (list_empty(&clp
->cl_superblocks
))
857 set_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
858 list_del(&server
->master_link
);
859 spin_unlock(&nn
->nfs_client_lock
);
863 EXPORT_SYMBOL_GPL(nfs_server_remove_lists
);
866 * Allocate and initialise a server record
868 struct nfs_server
*nfs_alloc_server(void)
870 struct nfs_server
*server
;
872 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
876 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
878 /* Zero out the NFS state stuff */
879 INIT_LIST_HEAD(&server
->client_link
);
880 INIT_LIST_HEAD(&server
->master_link
);
881 INIT_LIST_HEAD(&server
->delegations
);
882 INIT_LIST_HEAD(&server
->layouts
);
883 INIT_LIST_HEAD(&server
->state_owners_lru
);
884 INIT_LIST_HEAD(&server
->ss_copies
);
886 atomic_set(&server
->active
, 0);
888 server
->io_stats
= nfs_alloc_iostats();
889 if (!server
->io_stats
) {
894 ida_init(&server
->openowner_id
);
895 ida_init(&server
->lockowner_id
);
896 pnfs_init_server(server
);
897 rpc_init_wait_queue(&server
->uoc_rpcwaitq
, "NFS UOC");
901 EXPORT_SYMBOL_GPL(nfs_alloc_server
);
904 * Free up a server record
906 void nfs_free_server(struct nfs_server
*server
)
908 nfs_server_remove_lists(server
);
910 if (server
->destroy
!= NULL
)
911 server
->destroy(server
);
913 if (!IS_ERR(server
->client_acl
))
914 rpc_shutdown_client(server
->client_acl
);
915 if (!IS_ERR(server
->client
))
916 rpc_shutdown_client(server
->client
);
918 nfs_put_client(server
->nfs_client
);
920 ida_destroy(&server
->lockowner_id
);
921 ida_destroy(&server
->openowner_id
);
922 nfs_free_iostats(server
->io_stats
);
924 nfs_release_automount_timer();
926 EXPORT_SYMBOL_GPL(nfs_free_server
);
929 * Create a version 2 or 3 volume record
930 * - keyed on server and FSID
932 struct nfs_server
*nfs_create_server(struct nfs_mount_info
*mount_info
,
933 struct nfs_subversion
*nfs_mod
)
935 struct nfs_server
*server
;
936 struct nfs_fattr
*fattr
;
939 server
= nfs_alloc_server();
941 return ERR_PTR(-ENOMEM
);
944 fattr
= nfs_alloc_fattr();
948 /* Get a client representation */
949 error
= nfs_init_server(server
, mount_info
->parsed
, nfs_mod
);
953 /* Probe the root fh to retrieve its FSID */
954 error
= nfs_probe_fsinfo(server
, mount_info
->mntfh
, fattr
);
957 if (server
->nfs_client
->rpc_ops
->version
== 3) {
958 if (server
->namelen
== 0 || server
->namelen
> NFS3_MAXNAMLEN
)
959 server
->namelen
= NFS3_MAXNAMLEN
;
960 if (!(mount_info
->parsed
->flags
& NFS_MOUNT_NORDIRPLUS
))
961 server
->caps
|= NFS_CAP_READDIRPLUS
;
963 if (server
->namelen
== 0 || server
->namelen
> NFS2_MAXNAMLEN
)
964 server
->namelen
= NFS2_MAXNAMLEN
;
967 if (!(fattr
->valid
& NFS_ATTR_FATTR
)) {
968 error
= nfs_mod
->rpc_ops
->getattr(server
, mount_info
->mntfh
,
971 dprintk("nfs_create_server: getattr error = %d\n", -error
);
975 memcpy(&server
->fsid
, &fattr
->fsid
, sizeof(server
->fsid
));
977 dprintk("Server FSID: %llx:%llx\n",
978 (unsigned long long) server
->fsid
.major
,
979 (unsigned long long) server
->fsid
.minor
);
981 nfs_server_insert_lists(server
);
982 server
->mount_time
= jiffies
;
983 nfs_free_fattr(fattr
);
987 nfs_free_fattr(fattr
);
988 nfs_free_server(server
);
989 return ERR_PTR(error
);
991 EXPORT_SYMBOL_GPL(nfs_create_server
);
994 * Clone an NFS2, NFS3 or NFS4 server record
996 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
998 struct nfs_fattr
*fattr
,
999 rpc_authflavor_t flavor
)
1001 struct nfs_server
*server
;
1002 struct nfs_fattr
*fattr_fsinfo
;
1005 server
= nfs_alloc_server();
1007 return ERR_PTR(-ENOMEM
);
1010 fattr_fsinfo
= nfs_alloc_fattr();
1011 if (fattr_fsinfo
== NULL
)
1012 goto out_free_server
;
1014 /* Copy data from the source */
1015 server
->nfs_client
= source
->nfs_client
;
1016 server
->destroy
= source
->destroy
;
1017 refcount_inc(&server
->nfs_client
->cl_count
);
1018 nfs_server_copy_userdata(server
, source
);
1020 server
->fsid
= fattr
->fsid
;
1022 error
= nfs_init_server_rpcclient(server
,
1023 source
->client
->cl_timeout
,
1026 goto out_free_server
;
1028 /* probe the filesystem info for this server filesystem */
1029 error
= nfs_probe_fsinfo(server
, fh
, fattr_fsinfo
);
1031 goto out_free_server
;
1033 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1034 server
->namelen
= NFS4_MAXNAMLEN
;
1036 error
= nfs_start_lockd(server
);
1038 goto out_free_server
;
1040 nfs_server_insert_lists(server
);
1041 server
->mount_time
= jiffies
;
1043 nfs_free_fattr(fattr_fsinfo
);
1047 nfs_free_fattr(fattr_fsinfo
);
1048 nfs_free_server(server
);
1049 return ERR_PTR(error
);
1051 EXPORT_SYMBOL_GPL(nfs_clone_server
);
1053 void nfs_clients_init(struct net
*net
)
1055 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1057 INIT_LIST_HEAD(&nn
->nfs_client_list
);
1058 INIT_LIST_HEAD(&nn
->nfs_volume_list
);
1059 #if IS_ENABLED(CONFIG_NFS_V4)
1060 idr_init(&nn
->cb_ident_idr
);
1062 spin_lock_init(&nn
->nfs_client_lock
);
1063 nn
->boot_time
= ktime_get_real();
1066 #ifdef CONFIG_PROC_FS
1067 static void *nfs_server_list_start(struct seq_file
*p
, loff_t
*pos
);
1068 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1069 static void nfs_server_list_stop(struct seq_file
*p
, void *v
);
1070 static int nfs_server_list_show(struct seq_file
*m
, void *v
);
1072 static const struct seq_operations nfs_server_list_ops
= {
1073 .start
= nfs_server_list_start
,
1074 .next
= nfs_server_list_next
,
1075 .stop
= nfs_server_list_stop
,
1076 .show
= nfs_server_list_show
,
1079 static void *nfs_volume_list_start(struct seq_file
*p
, loff_t
*pos
);
1080 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1081 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
);
1082 static int nfs_volume_list_show(struct seq_file
*m
, void *v
);
1084 static const struct seq_operations nfs_volume_list_ops
= {
1085 .start
= nfs_volume_list_start
,
1086 .next
= nfs_volume_list_next
,
1087 .stop
= nfs_volume_list_stop
,
1088 .show
= nfs_volume_list_show
,
1092 * set up the iterator to start reading from the server list and return the first item
1094 static void *nfs_server_list_start(struct seq_file
*m
, loff_t
*_pos
)
1095 __acquires(&nn
->nfs_client_lock
)
1097 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1099 /* lock the list against modification */
1100 spin_lock(&nn
->nfs_client_lock
);
1101 return seq_list_start_head(&nn
->nfs_client_list
, *_pos
);
1105 * move to next server
1107 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1109 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1111 return seq_list_next(v
, &nn
->nfs_client_list
, pos
);
1115 * clean up after reading from the transports list
1117 static void nfs_server_list_stop(struct seq_file
*p
, void *v
)
1118 __releases(&nn
->nfs_client_lock
)
1120 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1122 spin_unlock(&nn
->nfs_client_lock
);
1126 * display a header line followed by a load of call lines
1128 static int nfs_server_list_show(struct seq_file
*m
, void *v
)
1130 struct nfs_client
*clp
;
1131 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1133 /* display header on line 1 */
1134 if (v
== &nn
->nfs_client_list
) {
1135 seq_puts(m
, "NV SERVER PORT USE HOSTNAME\n");
1139 /* display one transport per line on subsequent lines */
1140 clp
= list_entry(v
, struct nfs_client
, cl_share_link
);
1142 /* Check if the client is initialized */
1143 if (clp
->cl_cons_state
!= NFS_CS_READY
)
1147 seq_printf(m
, "v%u %s %s %3d %s\n",
1148 clp
->rpc_ops
->version
,
1149 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1150 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1151 refcount_read(&clp
->cl_count
),
1159 * set up the iterator to start reading from the volume list and return the first item
1161 static void *nfs_volume_list_start(struct seq_file
*m
, loff_t
*_pos
)
1162 __acquires(&nn
->nfs_client_lock
)
1164 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1166 /* lock the list against modification */
1167 spin_lock(&nn
->nfs_client_lock
);
1168 return seq_list_start_head(&nn
->nfs_volume_list
, *_pos
);
1172 * move to next volume
1174 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1176 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1178 return seq_list_next(v
, &nn
->nfs_volume_list
, pos
);
1182 * clean up after reading from the transports list
1184 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
)
1185 __releases(&nn
->nfs_client_lock
)
1187 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1189 spin_unlock(&nn
->nfs_client_lock
);
1193 * display a header line followed by a load of call lines
1195 static int nfs_volume_list_show(struct seq_file
*m
, void *v
)
1197 struct nfs_server
*server
;
1198 struct nfs_client
*clp
;
1199 char dev
[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1200 char fsid
[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1201 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1203 /* display header on line 1 */
1204 if (v
== &nn
->nfs_volume_list
) {
1205 seq_puts(m
, "NV SERVER PORT DEV FSID"
1209 /* display one transport per line on subsequent lines */
1210 server
= list_entry(v
, struct nfs_server
, master_link
);
1211 clp
= server
->nfs_client
;
1213 snprintf(dev
, sizeof(dev
), "%u:%u",
1214 MAJOR(server
->s_dev
), MINOR(server
->s_dev
));
1216 snprintf(fsid
, sizeof(fsid
), "%llx:%llx",
1217 (unsigned long long) server
->fsid
.major
,
1218 (unsigned long long) server
->fsid
.minor
);
1221 seq_printf(m
, "v%u %s %s %-12s %-33s %s\n",
1222 clp
->rpc_ops
->version
,
1223 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1224 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1227 nfs_server_fscache_state(server
));
1233 int nfs_fs_proc_net_init(struct net
*net
)
1235 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1236 struct proc_dir_entry
*p
;
1238 nn
->proc_nfsfs
= proc_net_mkdir(net
, "nfsfs", net
->proc_net
);
1239 if (!nn
->proc_nfsfs
)
1242 /* a file of servers with which we're dealing */
1243 p
= proc_create_net("servers", S_IFREG
|S_IRUGO
, nn
->proc_nfsfs
,
1244 &nfs_server_list_ops
, sizeof(struct seq_net_private
));
1248 /* a file of volumes that we have mounted */
1249 p
= proc_create_net("volumes", S_IFREG
|S_IRUGO
, nn
->proc_nfsfs
,
1250 &nfs_volume_list_ops
, sizeof(struct seq_net_private
));
1256 remove_proc_subtree("nfsfs", net
->proc_net
);
1261 void nfs_fs_proc_net_exit(struct net
*net
)
1263 remove_proc_subtree("nfsfs", net
->proc_net
);
1267 * initialise the /proc/fs/nfsfs/ directory
1269 int __init
nfs_fs_proc_init(void)
1271 if (!proc_mkdir("fs/nfsfs", NULL
))
1274 /* a file of servers with which we're dealing */
1275 if (!proc_symlink("fs/nfsfs/servers", NULL
, "../../net/nfsfs/servers"))
1278 /* a file of volumes that we have mounted */
1279 if (!proc_symlink("fs/nfsfs/volumes", NULL
, "../../net/nfsfs/volumes"))
1284 remove_proc_subtree("fs/nfsfs", NULL
);
1290 * clean up the /proc/fs/nfsfs/ directory
1292 void nfs_fs_proc_exit(void)
1294 remove_proc_subtree("fs/nfsfs", NULL
);
1297 #endif /* CONFIG_PROC_FS */