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
;
154 struct rpc_cred
*cred
;
157 if ((clp
= kzalloc(sizeof(*clp
), GFP_KERNEL
)) == NULL
)
160 clp
->cl_nfs_mod
= cl_init
->nfs_mod
;
161 if (!try_module_get(clp
->cl_nfs_mod
->owner
))
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
) {
174 clp
->cl_hostname
= kstrdup(cl_init
->hostname
, GFP_KERNEL
);
175 if (!clp
->cl_hostname
)
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("*");
187 clp
->cl_machine_cred
= cred
;
188 nfs_fscache_get_client_cookie(clp
);
193 put_nfs_version(clp
->cl_nfs_mod
);
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");
224 void nfs_cleanup_cb_ident_idr(struct net
*net
)
228 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
232 static void pnfs_init_server(struct nfs_server
*server
)
236 #endif /* CONFIG_NFS_V4 */
239 * Destroy a shared client record
241 void nfs_free_client(struct nfs_client
*clp
)
243 dprintk("--> nfs_free_client(%u)\n", clp
->rpc_ops
->version
);
245 nfs_fscache_release_client_cookie(clp
);
247 /* -EIO all pending I/O */
248 if (!IS_ERR(clp
->cl_rpcclient
))
249 rpc_shutdown_client(clp
->cl_rpcclient
);
251 if (clp
->cl_machine_cred
!= NULL
)
252 put_rpccred(clp
->cl_machine_cred
);
254 put_net(clp
->cl_net
);
255 put_nfs_version(clp
->cl_nfs_mod
);
256 kfree(clp
->cl_hostname
);
257 kfree(clp
->cl_acceptor
);
260 dprintk("<-- nfs_free_client()\n");
262 EXPORT_SYMBOL_GPL(nfs_free_client
);
265 * Release a reference to a shared client record
267 void nfs_put_client(struct nfs_client
*clp
)
274 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp
->cl_count
));
275 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
277 if (atomic_dec_and_lock(&clp
->cl_count
, &nn
->nfs_client_lock
)) {
278 list_del(&clp
->cl_share_link
);
279 nfs_cb_idr_remove_locked(clp
);
280 spin_unlock(&nn
->nfs_client_lock
);
282 WARN_ON_ONCE(!list_empty(&clp
->cl_superblocks
));
284 clp
->rpc_ops
->free_client(clp
);
287 EXPORT_SYMBOL_GPL(nfs_put_client
);
290 * Find an nfs_client on the list that matches the initialisation data
293 static struct nfs_client
*nfs_match_client(const struct nfs_client_initdata
*data
)
295 struct nfs_client
*clp
;
296 const struct sockaddr
*sap
= data
->addr
;
297 struct nfs_net
*nn
= net_generic(data
->net
, nfs_net_id
);
299 list_for_each_entry(clp
, &nn
->nfs_client_list
, cl_share_link
) {
300 const struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
301 /* Don't match clients that failed to initialise properly */
302 if (clp
->cl_cons_state
< 0)
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 atomic_inc(&clp
->cl_count
);
328 static bool nfs_client_init_is_complete(const struct nfs_client
*clp
)
330 return clp
->cl_cons_state
<= NFS_CS_READY
;
333 int nfs_wait_client_init_complete(const struct nfs_client
*clp
)
335 return wait_event_killable(nfs_client_active_wq
,
336 nfs_client_init_is_complete(clp
));
338 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete
);
341 * Found an existing client. Make sure it's ready before returning.
343 static struct nfs_client
*
344 nfs_found_client(const struct nfs_client_initdata
*cl_init
,
345 struct nfs_client
*clp
)
349 error
= nfs_wait_client_init_complete(clp
);
352 return ERR_PTR(-ERESTARTSYS
);
355 if (clp
->cl_cons_state
< NFS_CS_READY
) {
356 error
= clp
->cl_cons_state
;
358 return ERR_PTR(error
);
363 dprintk("<-- %s found nfs_client %p for %s\n",
364 __func__
, clp
, cl_init
->hostname
?: "");
369 * Look up a client by IP address and protocol version
370 * - creates a new record if one doesn't yet exist
373 nfs_get_client(const struct nfs_client_initdata
*cl_init
,
374 rpc_authflavor_t authflavour
)
376 struct nfs_client
*clp
, *new = NULL
;
377 struct nfs_net
*nn
= net_generic(cl_init
->net
, nfs_net_id
);
378 const struct nfs_rpc_ops
*rpc_ops
= cl_init
->nfs_mod
->rpc_ops
;
380 if (cl_init
->hostname
== NULL
) {
385 dprintk("--> nfs_get_client(%s,v%u)\n",
386 cl_init
->hostname
, rpc_ops
->version
);
388 /* see if the client already exists */
390 spin_lock(&nn
->nfs_client_lock
);
392 clp
= nfs_match_client(cl_init
);
394 spin_unlock(&nn
->nfs_client_lock
);
396 new->rpc_ops
->free_client(new);
397 return nfs_found_client(cl_init
, clp
);
400 list_add_tail(&new->cl_share_link
,
401 &nn
->nfs_client_list
);
402 spin_unlock(&nn
->nfs_client_lock
);
403 new->cl_flags
= cl_init
->init_flags
;
404 return rpc_ops
->init_client(new, cl_init
);
407 spin_unlock(&nn
->nfs_client_lock
);
409 new = rpc_ops
->alloc_client(cl_init
);
410 } while (!IS_ERR(new));
412 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
413 cl_init
->hostname
, PTR_ERR(new));
416 EXPORT_SYMBOL_GPL(nfs_get_client
);
419 * Mark a server as ready or failed
421 void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
424 clp
->cl_cons_state
= state
;
425 wake_up_all(&nfs_client_active_wq
);
427 EXPORT_SYMBOL_GPL(nfs_mark_client_ready
);
430 * Initialise the timeout values for a connection
432 void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
433 int timeo
, int retrans
)
435 to
->to_initval
= timeo
* HZ
/ 10;
436 to
->to_retries
= retrans
;
439 case XPRT_TRANSPORT_TCP
:
440 case XPRT_TRANSPORT_RDMA
:
441 if (retrans
== NFS_UNSPEC_RETRANS
)
442 to
->to_retries
= NFS_DEF_TCP_RETRANS
;
443 if (timeo
== NFS_UNSPEC_TIMEO
|| to
->to_retries
== 0)
444 to
->to_initval
= NFS_DEF_TCP_TIMEO
* HZ
/ 10;
445 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
446 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
447 to
->to_increment
= to
->to_initval
;
448 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
449 if (to
->to_maxval
> NFS_MAX_TCP_TIMEOUT
)
450 to
->to_maxval
= NFS_MAX_TCP_TIMEOUT
;
451 if (to
->to_maxval
< to
->to_initval
)
452 to
->to_maxval
= to
->to_initval
;
453 to
->to_exponential
= 0;
455 case XPRT_TRANSPORT_UDP
:
456 if (retrans
== NFS_UNSPEC_RETRANS
)
457 to
->to_retries
= NFS_DEF_UDP_RETRANS
;
458 if (timeo
== NFS_UNSPEC_TIMEO
|| to
->to_initval
== 0)
459 to
->to_initval
= NFS_DEF_UDP_TIMEO
* HZ
/ 10;
460 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
461 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
462 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
463 to
->to_exponential
= 1;
469 EXPORT_SYMBOL_GPL(nfs_init_timeout_values
);
472 * Create an RPC client handle
474 int nfs_create_rpc_client(struct nfs_client
*clp
,
475 const struct nfs_client_initdata
*cl_init
,
476 rpc_authflavor_t flavor
)
478 struct rpc_clnt
*clnt
= NULL
;
479 struct rpc_create_args args
= {
481 .protocol
= clp
->cl_proto
,
482 .address
= (struct sockaddr
*)&clp
->cl_addr
,
483 .addrsize
= clp
->cl_addrlen
,
484 .timeout
= cl_init
->timeparms
,
485 .servername
= clp
->cl_hostname
,
486 .nodename
= cl_init
->nodename
,
487 .program
= &nfs_program
,
488 .version
= clp
->rpc_ops
->version
,
489 .authflavor
= flavor
,
492 if (test_bit(NFS_CS_DISCRTRY
, &clp
->cl_flags
))
493 args
.flags
|= RPC_CLNT_CREATE_DISCRTRY
;
494 if (test_bit(NFS_CS_NO_RETRANS_TIMEOUT
, &clp
->cl_flags
))
495 args
.flags
|= RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT
;
496 if (test_bit(NFS_CS_NORESVPORT
, &clp
->cl_flags
))
497 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
498 if (test_bit(NFS_CS_INFINITE_SLOTS
, &clp
->cl_flags
))
499 args
.flags
|= RPC_CLNT_CREATE_INFINITE_SLOTS
;
501 if (!IS_ERR(clp
->cl_rpcclient
))
504 clnt
= rpc_create(&args
);
506 dprintk("%s: cannot create RPC client. Error = %ld\n",
507 __func__
, PTR_ERR(clnt
));
508 return PTR_ERR(clnt
);
511 clp
->cl_rpcclient
= clnt
;
514 EXPORT_SYMBOL_GPL(nfs_create_rpc_client
);
517 * Version 2 or 3 client destruction
519 static void nfs_destroy_server(struct nfs_server
*server
)
521 if (server
->nlm_host
)
522 nlmclnt_done(server
->nlm_host
);
526 * Version 2 or 3 lockd setup
528 static int nfs_start_lockd(struct nfs_server
*server
)
530 struct nlm_host
*host
;
531 struct nfs_client
*clp
= server
->nfs_client
;
532 struct nlmclnt_initdata nlm_init
= {
533 .hostname
= clp
->cl_hostname
,
534 .address
= (struct sockaddr
*)&clp
->cl_addr
,
535 .addrlen
= clp
->cl_addrlen
,
536 .nfs_version
= clp
->rpc_ops
->version
,
537 .noresvport
= server
->flags
& NFS_MOUNT_NORESVPORT
?
542 if (nlm_init
.nfs_version
> 3)
544 if ((server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) &&
545 (server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
548 switch (clp
->cl_proto
) {
550 nlm_init
.protocol
= IPPROTO_TCP
;
552 case XPRT_TRANSPORT_UDP
:
553 nlm_init
.protocol
= IPPROTO_UDP
;
556 host
= nlmclnt_init(&nlm_init
);
558 return PTR_ERR(host
);
560 server
->nlm_host
= host
;
561 server
->destroy
= nfs_destroy_server
;
566 * Create a general RPC client
568 int nfs_init_server_rpcclient(struct nfs_server
*server
,
569 const struct rpc_timeout
*timeo
,
570 rpc_authflavor_t pseudoflavour
)
572 struct nfs_client
*clp
= server
->nfs_client
;
574 server
->client
= rpc_clone_client_set_auth(clp
->cl_rpcclient
,
576 if (IS_ERR(server
->client
)) {
577 dprintk("%s: couldn't create rpc_client!\n", __func__
);
578 return PTR_ERR(server
->client
);
581 memcpy(&server
->client
->cl_timeout_default
,
583 sizeof(server
->client
->cl_timeout_default
));
584 server
->client
->cl_timeout
= &server
->client
->cl_timeout_default
;
585 server
->client
->cl_softrtry
= 0;
586 if (server
->flags
& NFS_MOUNT_SOFT
)
587 server
->client
->cl_softrtry
= 1;
591 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient
);
594 * nfs_init_client - Initialise an NFS2 or NFS3 client
596 * @clp: nfs_client to initialise
597 * @cl_init: Initialisation parameters
599 * Returns pointer to an NFS client, or an ERR_PTR value.
601 struct nfs_client
*nfs_init_client(struct nfs_client
*clp
,
602 const struct nfs_client_initdata
*cl_init
)
606 if (clp
->cl_cons_state
== NFS_CS_READY
) {
607 /* the client is already initialised */
608 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp
);
613 * Create a client RPC handle for doing FSSTAT with UNIX auth only
614 * - RFC 2623, sec 2.3.2
616 error
= nfs_create_rpc_client(clp
, cl_init
, RPC_AUTH_UNIX
);
619 nfs_mark_client_ready(clp
, NFS_CS_READY
);
623 nfs_mark_client_ready(clp
, error
);
625 dprintk("<-- nfs_init_client() = xerror %d\n", error
);
626 return ERR_PTR(error
);
628 EXPORT_SYMBOL_GPL(nfs_init_client
);
631 * Create a version 2 or 3 client
633 static int nfs_init_server(struct nfs_server
*server
,
634 const struct nfs_parsed_mount_data
*data
,
635 struct nfs_subversion
*nfs_mod
)
637 struct rpc_timeout timeparms
;
638 struct nfs_client_initdata cl_init
= {
639 .hostname
= data
->nfs_server
.hostname
,
640 .addr
= (const struct sockaddr
*)&data
->nfs_server
.address
,
641 .addrlen
= data
->nfs_server
.addrlen
,
643 .proto
= data
->nfs_server
.protocol
,
645 .timeparms
= &timeparms
,
647 struct nfs_client
*clp
;
650 dprintk("--> nfs_init_server()\n");
652 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
653 data
->timeo
, data
->retrans
);
654 if (data
->flags
& NFS_MOUNT_NORESVPORT
)
655 set_bit(NFS_CS_NORESVPORT
, &cl_init
.init_flags
);
657 /* Allocate or find a client reference we can use */
658 clp
= nfs_get_client(&cl_init
, RPC_AUTH_UNIX
);
660 dprintk("<-- nfs_init_server() = error %ld\n", 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
;
674 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
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
);
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
);
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 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp
);
711 server
->nfs_client
= NULL
;
713 dprintk("<-- nfs_init_server() = xerror %d\n", error
);
718 * Load up the server record from information gained in an fsinfo record
720 static void nfs_server_set_fsinfo(struct nfs_server
*server
,
721 struct nfs_fsinfo
*fsinfo
)
723 unsigned long max_rpc_payload
;
725 /* Work out a lot of parameters */
726 if (server
->rsize
== 0)
727 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
728 if (server
->wsize
== 0)
729 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
731 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
732 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
733 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
734 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
736 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
737 if (server
->rsize
> max_rpc_payload
)
738 server
->rsize
= max_rpc_payload
;
739 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
740 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
741 server
->rpages
= (server
->rsize
+ PAGE_SIZE
- 1) >> PAGE_SHIFT
;
743 server
->backing_dev_info
.name
= "nfs";
744 server
->backing_dev_info
.ra_pages
= server
->rpages
* NFS_MAX_READAHEAD
;
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 dprintk("--> nfs_probe_fsinfo()\n");
785 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
786 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
791 fsinfo
.fattr
= fattr
;
792 fsinfo
.nlayouttypes
= 0;
793 memset(fsinfo
.layouttype
, 0, sizeof(fsinfo
.layouttype
));
794 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
798 nfs_server_set_fsinfo(server
, &fsinfo
);
800 /* Get some general file system info */
801 if (server
->namelen
== 0) {
802 struct nfs_pathconf pathinfo
;
804 pathinfo
.fattr
= fattr
;
805 nfs_fattr_init(fattr
);
807 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
808 server
->namelen
= pathinfo
.max_namelen
;
811 dprintk("<-- nfs_probe_fsinfo() = 0\n");
815 dprintk("nfs_probe_fsinfo: error = %d\n", -error
);
818 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo
);
821 * Copy useful information when duplicating a server record
823 void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
825 target
->flags
= source
->flags
;
826 target
->rsize
= source
->rsize
;
827 target
->wsize
= source
->wsize
;
828 target
->acregmin
= source
->acregmin
;
829 target
->acregmax
= source
->acregmax
;
830 target
->acdirmin
= source
->acdirmin
;
831 target
->acdirmax
= source
->acdirmax
;
832 target
->caps
= source
->caps
;
833 target
->options
= source
->options
;
834 target
->auth_info
= source
->auth_info
;
836 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata
);
838 void nfs_server_insert_lists(struct nfs_server
*server
)
840 struct nfs_client
*clp
= server
->nfs_client
;
841 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
843 spin_lock(&nn
->nfs_client_lock
);
844 list_add_tail_rcu(&server
->client_link
, &clp
->cl_superblocks
);
845 list_add_tail(&server
->master_link
, &nn
->nfs_volume_list
);
846 clear_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
847 spin_unlock(&nn
->nfs_client_lock
);
850 EXPORT_SYMBOL_GPL(nfs_server_insert_lists
);
852 void nfs_server_remove_lists(struct nfs_server
*server
)
854 struct nfs_client
*clp
= server
->nfs_client
;
859 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
860 spin_lock(&nn
->nfs_client_lock
);
861 list_del_rcu(&server
->client_link
);
862 if (list_empty(&clp
->cl_superblocks
))
863 set_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
864 list_del(&server
->master_link
);
865 spin_unlock(&nn
->nfs_client_lock
);
869 EXPORT_SYMBOL_GPL(nfs_server_remove_lists
);
872 * Allocate and initialise a server record
874 struct nfs_server
*nfs_alloc_server(void)
876 struct nfs_server
*server
;
878 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
882 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
884 /* Zero out the NFS state stuff */
885 INIT_LIST_HEAD(&server
->client_link
);
886 INIT_LIST_HEAD(&server
->master_link
);
887 INIT_LIST_HEAD(&server
->delegations
);
888 INIT_LIST_HEAD(&server
->layouts
);
889 INIT_LIST_HEAD(&server
->state_owners_lru
);
891 atomic_set(&server
->active
, 0);
893 server
->io_stats
= nfs_alloc_iostats();
894 if (!server
->io_stats
) {
899 if (bdi_init(&server
->backing_dev_info
)) {
900 nfs_free_iostats(server
->io_stats
);
905 ida_init(&server
->openowner_id
);
906 ida_init(&server
->lockowner_id
);
907 pnfs_init_server(server
);
911 EXPORT_SYMBOL_GPL(nfs_alloc_server
);
914 * Free up a server record
916 void nfs_free_server(struct nfs_server
*server
)
918 dprintk("--> nfs_free_server()\n");
920 nfs_server_remove_lists(server
);
922 if (server
->destroy
!= NULL
)
923 server
->destroy(server
);
925 if (!IS_ERR(server
->client_acl
))
926 rpc_shutdown_client(server
->client_acl
);
927 if (!IS_ERR(server
->client
))
928 rpc_shutdown_client(server
->client
);
930 nfs_put_client(server
->nfs_client
);
932 ida_destroy(&server
->lockowner_id
);
933 ida_destroy(&server
->openowner_id
);
934 nfs_free_iostats(server
->io_stats
);
935 bdi_destroy(&server
->backing_dev_info
);
937 nfs_release_automount_timer();
938 dprintk("<-- nfs_free_server()\n");
940 EXPORT_SYMBOL_GPL(nfs_free_server
);
943 * Create a version 2 or 3 volume record
944 * - keyed on server and FSID
946 struct nfs_server
*nfs_create_server(struct nfs_mount_info
*mount_info
,
947 struct nfs_subversion
*nfs_mod
)
949 struct nfs_server
*server
;
950 struct nfs_fattr
*fattr
;
953 server
= nfs_alloc_server();
955 return ERR_PTR(-ENOMEM
);
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
, fattr
, NULL
);
984 dprintk("nfs_create_server: getattr error = %d\n", -error
);
988 memcpy(&server
->fsid
, &fattr
->fsid
, sizeof(server
->fsid
));
990 dprintk("Server FSID: %llx:%llx\n",
991 (unsigned long long) server
->fsid
.major
,
992 (unsigned long long) server
->fsid
.minor
);
994 nfs_server_insert_lists(server
);
995 server
->mount_time
= jiffies
;
996 nfs_free_fattr(fattr
);
1000 nfs_free_fattr(fattr
);
1001 nfs_free_server(server
);
1002 return ERR_PTR(error
);
1004 EXPORT_SYMBOL_GPL(nfs_create_server
);
1007 * Clone an NFS2, NFS3 or NFS4 server record
1009 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
1011 struct nfs_fattr
*fattr
,
1012 rpc_authflavor_t flavor
)
1014 struct nfs_server
*server
;
1015 struct nfs_fattr
*fattr_fsinfo
;
1018 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1019 (unsigned long long) fattr
->fsid
.major
,
1020 (unsigned long long) fattr
->fsid
.minor
);
1022 server
= nfs_alloc_server();
1024 return ERR_PTR(-ENOMEM
);
1027 fattr_fsinfo
= nfs_alloc_fattr();
1028 if (fattr_fsinfo
== NULL
)
1029 goto out_free_server
;
1031 /* Copy data from the source */
1032 server
->nfs_client
= source
->nfs_client
;
1033 server
->destroy
= source
->destroy
;
1034 atomic_inc(&server
->nfs_client
->cl_count
);
1035 nfs_server_copy_userdata(server
, source
);
1037 server
->fsid
= fattr
->fsid
;
1039 error
= nfs_init_server_rpcclient(server
,
1040 source
->client
->cl_timeout
,
1043 goto out_free_server
;
1045 /* probe the filesystem info for this server filesystem */
1046 error
= nfs_probe_fsinfo(server
, fh
, fattr_fsinfo
);
1048 goto out_free_server
;
1050 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1051 server
->namelen
= NFS4_MAXNAMLEN
;
1053 dprintk("Cloned FSID: %llx:%llx\n",
1054 (unsigned long long) server
->fsid
.major
,
1055 (unsigned long long) server
->fsid
.minor
);
1057 error
= nfs_start_lockd(server
);
1059 goto out_free_server
;
1061 nfs_server_insert_lists(server
);
1062 server
->mount_time
= jiffies
;
1064 nfs_free_fattr(fattr_fsinfo
);
1065 dprintk("<-- nfs_clone_server() = %p\n", server
);
1069 nfs_free_fattr(fattr_fsinfo
);
1070 nfs_free_server(server
);
1071 dprintk("<-- nfs_clone_server() = error %d\n", error
);
1072 return ERR_PTR(error
);
1074 EXPORT_SYMBOL_GPL(nfs_clone_server
);
1076 void nfs_clients_init(struct net
*net
)
1078 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1080 INIT_LIST_HEAD(&nn
->nfs_client_list
);
1081 INIT_LIST_HEAD(&nn
->nfs_volume_list
);
1082 #if IS_ENABLED(CONFIG_NFS_V4)
1083 idr_init(&nn
->cb_ident_idr
);
1085 spin_lock_init(&nn
->nfs_client_lock
);
1086 nn
->boot_time
= ktime_get_real();
1089 #ifdef CONFIG_PROC_FS
1090 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
);
1091 static void *nfs_server_list_start(struct seq_file
*p
, loff_t
*pos
);
1092 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1093 static void nfs_server_list_stop(struct seq_file
*p
, void *v
);
1094 static int nfs_server_list_show(struct seq_file
*m
, void *v
);
1096 static const struct seq_operations nfs_server_list_ops
= {
1097 .start
= nfs_server_list_start
,
1098 .next
= nfs_server_list_next
,
1099 .stop
= nfs_server_list_stop
,
1100 .show
= nfs_server_list_show
,
1103 static const struct file_operations nfs_server_list_fops
= {
1104 .open
= nfs_server_list_open
,
1106 .llseek
= seq_lseek
,
1107 .release
= seq_release_net
,
1110 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
);
1111 static void *nfs_volume_list_start(struct seq_file
*p
, loff_t
*pos
);
1112 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1113 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
);
1114 static int nfs_volume_list_show(struct seq_file
*m
, void *v
);
1116 static const struct seq_operations nfs_volume_list_ops
= {
1117 .start
= nfs_volume_list_start
,
1118 .next
= nfs_volume_list_next
,
1119 .stop
= nfs_volume_list_stop
,
1120 .show
= nfs_volume_list_show
,
1123 static const struct file_operations nfs_volume_list_fops
= {
1124 .open
= nfs_volume_list_open
,
1126 .llseek
= seq_lseek
,
1127 .release
= seq_release_net
,
1131 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1134 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
)
1136 return seq_open_net(inode
, file
, &nfs_server_list_ops
,
1137 sizeof(struct seq_net_private
));
1141 * set up the iterator to start reading from the server list and return the first item
1143 static void *nfs_server_list_start(struct seq_file
*m
, loff_t
*_pos
)
1144 __acquires(&nn
->nfs_client_lock
)
1146 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1148 /* lock the list against modification */
1149 spin_lock(&nn
->nfs_client_lock
);
1150 return seq_list_start_head(&nn
->nfs_client_list
, *_pos
);
1154 * move to next server
1156 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1158 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1160 return seq_list_next(v
, &nn
->nfs_client_list
, pos
);
1164 * clean up after reading from the transports list
1166 static void nfs_server_list_stop(struct seq_file
*p
, void *v
)
1167 __releases(&nn
->nfs_client_lock
)
1169 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1171 spin_unlock(&nn
->nfs_client_lock
);
1175 * display a header line followed by a load of call lines
1177 static int nfs_server_list_show(struct seq_file
*m
, void *v
)
1179 struct nfs_client
*clp
;
1180 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1182 /* display header on line 1 */
1183 if (v
== &nn
->nfs_client_list
) {
1184 seq_puts(m
, "NV SERVER PORT USE HOSTNAME\n");
1188 /* display one transport per line on subsequent lines */
1189 clp
= list_entry(v
, struct nfs_client
, cl_share_link
);
1191 /* Check if the client is initialized */
1192 if (clp
->cl_cons_state
!= NFS_CS_READY
)
1196 seq_printf(m
, "v%u %s %s %3d %s\n",
1197 clp
->rpc_ops
->version
,
1198 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1199 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1200 atomic_read(&clp
->cl_count
),
1208 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1210 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
)
1212 return seq_open_net(inode
, file
, &nfs_volume_list_ops
,
1213 sizeof(struct seq_net_private
));
1217 * set up the iterator to start reading from the volume list and return the first item
1219 static void *nfs_volume_list_start(struct seq_file
*m
, loff_t
*_pos
)
1220 __acquires(&nn
->nfs_client_lock
)
1222 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1224 /* lock the list against modification */
1225 spin_lock(&nn
->nfs_client_lock
);
1226 return seq_list_start_head(&nn
->nfs_volume_list
, *_pos
);
1230 * move to next volume
1232 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1234 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1236 return seq_list_next(v
, &nn
->nfs_volume_list
, pos
);
1240 * clean up after reading from the transports list
1242 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
)
1243 __releases(&nn
->nfs_client_lock
)
1245 struct nfs_net
*nn
= net_generic(seq_file_net(p
), nfs_net_id
);
1247 spin_unlock(&nn
->nfs_client_lock
);
1251 * display a header line followed by a load of call lines
1253 static int nfs_volume_list_show(struct seq_file
*m
, void *v
)
1255 struct nfs_server
*server
;
1256 struct nfs_client
*clp
;
1257 char dev
[13]; // 8 for 2^24, 1 for ':', 3 for 2^8, 1 for '\0'
1258 char fsid
[34]; // 2 * 16 for %llx, 1 for ':', 1 for '\0'
1259 struct nfs_net
*nn
= net_generic(seq_file_net(m
), nfs_net_id
);
1261 /* display header on line 1 */
1262 if (v
== &nn
->nfs_volume_list
) {
1263 seq_puts(m
, "NV SERVER PORT DEV FSID"
1267 /* display one transport per line on subsequent lines */
1268 server
= list_entry(v
, struct nfs_server
, master_link
);
1269 clp
= server
->nfs_client
;
1271 snprintf(dev
, sizeof(dev
), "%u:%u",
1272 MAJOR(server
->s_dev
), MINOR(server
->s_dev
));
1274 snprintf(fsid
, sizeof(fsid
), "%llx:%llx",
1275 (unsigned long long) server
->fsid
.major
,
1276 (unsigned long long) server
->fsid
.minor
);
1279 seq_printf(m
, "v%u %s %s %-12s %-33s %s\n",
1280 clp
->rpc_ops
->version
,
1281 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1282 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1285 nfs_server_fscache_state(server
));
1291 int nfs_fs_proc_net_init(struct net
*net
)
1293 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1294 struct proc_dir_entry
*p
;
1296 nn
->proc_nfsfs
= proc_net_mkdir(net
, "nfsfs", net
->proc_net
);
1297 if (!nn
->proc_nfsfs
)
1300 /* a file of servers with which we're dealing */
1301 p
= proc_create("servers", S_IFREG
|S_IRUGO
,
1302 nn
->proc_nfsfs
, &nfs_server_list_fops
);
1306 /* a file of volumes that we have mounted */
1307 p
= proc_create("volumes", S_IFREG
|S_IRUGO
,
1308 nn
->proc_nfsfs
, &nfs_volume_list_fops
);
1314 remove_proc_subtree("nfsfs", net
->proc_net
);
1319 void nfs_fs_proc_net_exit(struct net
*net
)
1321 remove_proc_subtree("nfsfs", net
->proc_net
);
1325 * initialise the /proc/fs/nfsfs/ directory
1327 int __init
nfs_fs_proc_init(void)
1329 if (!proc_mkdir("fs/nfsfs", NULL
))
1332 /* a file of servers with which we're dealing */
1333 if (!proc_symlink("fs/nfsfs/servers", NULL
, "../../net/nfsfs/servers"))
1336 /* a file of volumes that we have mounted */
1337 if (!proc_symlink("fs/nfsfs/volumes", NULL
, "../../net/nfsfs/volumes"))
1342 remove_proc_subtree("fs/nfsfs", NULL
);
1348 * clean up the /proc/fs/nfsfs/ directory
1350 void nfs_fs_proc_exit(void)
1352 remove_proc_subtree("fs/nfsfs", NULL
);
1355 #endif /* CONFIG_PROC_FS */