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/clnt.h>
24 #include <linux/sunrpc/stats.h>
25 #include <linux/sunrpc/metrics.h>
26 #include <linux/sunrpc/xprtsock.h>
27 #include <linux/sunrpc/xprtrdma.h>
28 #include <linux/nfs_fs.h>
29 #include <linux/nfs_mount.h>
30 #include <linux/nfs4_mount.h>
31 #include <linux/lockd/bind.h>
32 #include <linux/seq_file.h>
33 #include <linux/mount.h>
34 #include <linux/nfs_idmap.h>
35 #include <linux/vfs.h>
36 #include <linux/inet.h>
37 #include <linux/in6.h>
38 #include <linux/slab.h>
39 #include <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("nfs%d", version
);
109 nfs
= find_nfs_version(version
);
110 mutex_unlock(&nfs_version_mutex
);
114 try_module_get(nfs
->owner
);
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 * Preload all configured NFS versions during module init.
147 * This function should be edited after each protocol is converted,
148 * and eventually removed.
150 int __init
nfs_register_versions(void)
152 return init_nfs_v4();
156 * Remove each pre-loaded NFS version
158 void nfs_unregister_versions(void)
164 * Allocate a shared client record
166 * Since these are allocated/deallocated very rarely, we don't
167 * bother putting them in a slab cache...
169 struct nfs_client
*nfs_alloc_client(const struct nfs_client_initdata
*cl_init
)
171 struct nfs_client
*clp
;
172 struct rpc_cred
*cred
;
175 if ((clp
= kzalloc(sizeof(*clp
), GFP_KERNEL
)) == NULL
)
178 clp
->cl_nfs_mod
= cl_init
->nfs_mod
;
179 try_module_get(clp
->cl_nfs_mod
->owner
);
181 clp
->rpc_ops
= clp
->cl_nfs_mod
->rpc_ops
;
183 atomic_set(&clp
->cl_count
, 1);
184 clp
->cl_cons_state
= NFS_CS_INITING
;
186 memcpy(&clp
->cl_addr
, cl_init
->addr
, cl_init
->addrlen
);
187 clp
->cl_addrlen
= cl_init
->addrlen
;
189 if (cl_init
->hostname
) {
191 clp
->cl_hostname
= kstrdup(cl_init
->hostname
, GFP_KERNEL
);
192 if (!clp
->cl_hostname
)
196 INIT_LIST_HEAD(&clp
->cl_superblocks
);
197 clp
->cl_rpcclient
= ERR_PTR(-EINVAL
);
199 clp
->cl_proto
= cl_init
->proto
;
200 clp
->cl_net
= get_net(cl_init
->net
);
202 cred
= rpc_lookup_machine_cred("*");
204 clp
->cl_machine_cred
= cred
;
205 nfs_fscache_get_client_cookie(clp
);
210 put_nfs_version(clp
->cl_nfs_mod
);
215 EXPORT_SYMBOL_GPL(nfs_alloc_client
);
218 /* idr_remove_all is not needed as all id's are removed by nfs_put_client */
219 void nfs_cleanup_cb_ident_idr(struct net
*net
)
221 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
223 idr_destroy(&nn
->cb_ident_idr
);
226 /* nfs_client_lock held */
227 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
229 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
231 if (clp
->cl_cb_ident
)
232 idr_remove(&nn
->cb_ident_idr
, clp
->cl_cb_ident
);
235 static void pnfs_init_server(struct nfs_server
*server
)
237 rpc_init_wait_queue(&server
->roc_rpcwaitq
, "pNFS ROC");
241 void nfs_cleanup_cb_ident_idr(struct net
*net
)
245 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
249 static void pnfs_init_server(struct nfs_server
*server
)
253 #endif /* CONFIG_NFS_V4 */
256 * Destroy a shared client record
258 void nfs_free_client(struct nfs_client
*clp
)
260 dprintk("--> nfs_free_client(%u)\n", clp
->rpc_ops
->version
);
262 nfs_fscache_release_client_cookie(clp
);
264 /* -EIO all pending I/O */
265 if (!IS_ERR(clp
->cl_rpcclient
))
266 rpc_shutdown_client(clp
->cl_rpcclient
);
268 if (clp
->cl_machine_cred
!= NULL
)
269 put_rpccred(clp
->cl_machine_cred
);
271 put_net(clp
->cl_net
);
272 put_nfs_version(clp
->cl_nfs_mod
);
273 kfree(clp
->cl_hostname
);
276 dprintk("<-- nfs_free_client()\n");
278 EXPORT_SYMBOL_GPL(nfs_free_client
);
281 * Release a reference to a shared client record
283 void nfs_put_client(struct nfs_client
*clp
)
290 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp
->cl_count
));
291 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
293 if (atomic_dec_and_lock(&clp
->cl_count
, &nn
->nfs_client_lock
)) {
294 list_del(&clp
->cl_share_link
);
295 nfs_cb_idr_remove_locked(clp
);
296 spin_unlock(&nn
->nfs_client_lock
);
298 BUG_ON(!list_empty(&clp
->cl_superblocks
));
300 clp
->rpc_ops
->free_client(clp
);
303 EXPORT_SYMBOL_GPL(nfs_put_client
);
305 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
307 * Test if two ip6 socket addresses refer to the same socket by
308 * comparing relevant fields. The padding bytes specifically, are not
309 * compared. sin6_flowinfo is not compared because it only affects QoS
310 * and sin6_scope_id is only compared if the address is "link local"
311 * because "link local" addresses need only be unique to a specific
312 * link. Conversely, ordinary unicast addresses might have different
315 * The caller should ensure both socket addresses are AF_INET6.
317 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr
*sa1
,
318 const struct sockaddr
*sa2
)
320 const struct sockaddr_in6
*sin1
= (const struct sockaddr_in6
*)sa1
;
321 const struct sockaddr_in6
*sin2
= (const struct sockaddr_in6
*)sa2
;
323 if (!ipv6_addr_equal(&sin1
->sin6_addr
, &sin2
->sin6_addr
))
325 else if (ipv6_addr_type(&sin1
->sin6_addr
) & IPV6_ADDR_LINKLOCAL
)
326 return sin1
->sin6_scope_id
== sin2
->sin6_scope_id
;
330 #else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
331 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr
*sa1
,
332 const struct sockaddr
*sa2
)
339 * Test if two ip4 socket addresses refer to the same socket, by
340 * comparing relevant fields. The padding bytes specifically, are
343 * The caller should ensure both socket addresses are AF_INET.
345 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr
*sa1
,
346 const struct sockaddr
*sa2
)
348 const struct sockaddr_in
*sin1
= (const struct sockaddr_in
*)sa1
;
349 const struct sockaddr_in
*sin2
= (const struct sockaddr_in
*)sa2
;
351 return sin1
->sin_addr
.s_addr
== sin2
->sin_addr
.s_addr
;
354 static int nfs_sockaddr_cmp_ip6(const struct sockaddr
*sa1
,
355 const struct sockaddr
*sa2
)
357 const struct sockaddr_in6
*sin1
= (const struct sockaddr_in6
*)sa1
;
358 const struct sockaddr_in6
*sin2
= (const struct sockaddr_in6
*)sa2
;
360 return nfs_sockaddr_match_ipaddr6(sa1
, sa2
) &&
361 (sin1
->sin6_port
== sin2
->sin6_port
);
364 static int nfs_sockaddr_cmp_ip4(const struct sockaddr
*sa1
,
365 const struct sockaddr
*sa2
)
367 const struct sockaddr_in
*sin1
= (const struct sockaddr_in
*)sa1
;
368 const struct sockaddr_in
*sin2
= (const struct sockaddr_in
*)sa2
;
370 return nfs_sockaddr_match_ipaddr4(sa1
, sa2
) &&
371 (sin1
->sin_port
== sin2
->sin_port
);
374 #if defined(CONFIG_NFS_V4_1)
376 * Test if two socket addresses represent the same actual socket,
377 * by comparing (only) relevant fields, excluding the port number.
379 int nfs_sockaddr_match_ipaddr(const struct sockaddr
*sa1
,
380 const struct sockaddr
*sa2
)
382 if (sa1
->sa_family
!= sa2
->sa_family
)
385 switch (sa1
->sa_family
) {
387 return nfs_sockaddr_match_ipaddr4(sa1
, sa2
);
389 return nfs_sockaddr_match_ipaddr6(sa1
, sa2
);
393 #endif /* CONFIG_NFS_V4_1 */
396 * Test if two socket addresses represent the same actual socket,
397 * by comparing (only) relevant fields, including the port number.
399 static int nfs_sockaddr_cmp(const struct sockaddr
*sa1
,
400 const struct sockaddr
*sa2
)
402 if (sa1
->sa_family
!= sa2
->sa_family
)
405 switch (sa1
->sa_family
) {
407 return nfs_sockaddr_cmp_ip4(sa1
, sa2
);
409 return nfs_sockaddr_cmp_ip6(sa1
, sa2
);
415 * Find an nfs_client on the list that matches the initialisation data
418 static struct nfs_client
*nfs_match_client(const struct nfs_client_initdata
*data
)
420 struct nfs_client
*clp
;
421 const struct sockaddr
*sap
= data
->addr
;
422 struct nfs_net
*nn
= net_generic(data
->net
, nfs_net_id
);
424 list_for_each_entry(clp
, &nn
->nfs_client_list
, cl_share_link
) {
425 const struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
426 /* Don't match clients that failed to initialise properly */
427 if (clp
->cl_cons_state
< 0)
430 /* Different NFS versions cannot share the same nfs_client */
431 if (clp
->rpc_ops
!= data
->nfs_mod
->rpc_ops
)
434 if (clp
->cl_proto
!= data
->proto
)
436 /* Match nfsv4 minorversion */
437 if (clp
->cl_minorversion
!= data
->minorversion
)
439 /* Match the full socket address */
440 if (!nfs_sockaddr_cmp(sap
, clap
))
443 atomic_inc(&clp
->cl_count
);
449 static bool nfs_client_init_is_complete(const struct nfs_client
*clp
)
451 return clp
->cl_cons_state
!= NFS_CS_INITING
;
454 int nfs_wait_client_init_complete(const struct nfs_client
*clp
)
456 return wait_event_killable(nfs_client_active_wq
,
457 nfs_client_init_is_complete(clp
));
461 * Found an existing client. Make sure it's ready before returning.
463 static struct nfs_client
*
464 nfs_found_client(const struct nfs_client_initdata
*cl_init
,
465 struct nfs_client
*clp
)
469 error
= nfs_wait_client_init_complete(clp
);
472 return ERR_PTR(-ERESTARTSYS
);
475 if (clp
->cl_cons_state
< NFS_CS_READY
) {
476 error
= clp
->cl_cons_state
;
478 return ERR_PTR(error
);
483 dprintk("<-- %s found nfs_client %p for %s\n",
484 __func__
, clp
, cl_init
->hostname
?: "");
489 * Look up a client by IP address and protocol version
490 * - creates a new record if one doesn't yet exist
493 nfs_get_client(const struct nfs_client_initdata
*cl_init
,
494 const struct rpc_timeout
*timeparms
,
496 rpc_authflavor_t authflavour
)
498 struct nfs_client
*clp
, *new = NULL
;
499 struct nfs_net
*nn
= net_generic(cl_init
->net
, nfs_net_id
);
500 const struct nfs_rpc_ops
*rpc_ops
= cl_init
->nfs_mod
->rpc_ops
;
502 dprintk("--> nfs_get_client(%s,v%u)\n",
503 cl_init
->hostname
?: "", rpc_ops
->version
);
505 /* see if the client already exists */
507 spin_lock(&nn
->nfs_client_lock
);
509 clp
= nfs_match_client(cl_init
);
511 spin_unlock(&nn
->nfs_client_lock
);
513 new->rpc_ops
->free_client(new);
514 return nfs_found_client(cl_init
, clp
);
517 list_add(&new->cl_share_link
, &nn
->nfs_client_list
);
518 spin_unlock(&nn
->nfs_client_lock
);
519 new->cl_flags
= cl_init
->init_flags
;
520 return rpc_ops
->init_client(new, timeparms
, ip_addr
,
524 spin_unlock(&nn
->nfs_client_lock
);
526 new = rpc_ops
->alloc_client(cl_init
);
527 } while (!IS_ERR(new));
529 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
530 cl_init
->hostname
?: "", PTR_ERR(new));
535 * Mark a server as ready or failed
537 void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
540 clp
->cl_cons_state
= state
;
541 wake_up_all(&nfs_client_active_wq
);
545 * Initialise the timeout values for a connection
547 void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
548 unsigned int timeo
, unsigned int retrans
)
550 to
->to_initval
= timeo
* HZ
/ 10;
551 to
->to_retries
= retrans
;
554 case XPRT_TRANSPORT_TCP
:
555 case XPRT_TRANSPORT_RDMA
:
556 if (to
->to_retries
== 0)
557 to
->to_retries
= NFS_DEF_TCP_RETRANS
;
558 if (to
->to_initval
== 0)
559 to
->to_initval
= NFS_DEF_TCP_TIMEO
* HZ
/ 10;
560 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
561 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
562 to
->to_increment
= to
->to_initval
;
563 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
564 if (to
->to_maxval
> NFS_MAX_TCP_TIMEOUT
)
565 to
->to_maxval
= NFS_MAX_TCP_TIMEOUT
;
566 if (to
->to_maxval
< to
->to_initval
)
567 to
->to_maxval
= to
->to_initval
;
568 to
->to_exponential
= 0;
570 case XPRT_TRANSPORT_UDP
:
571 if (to
->to_retries
== 0)
572 to
->to_retries
= NFS_DEF_UDP_RETRANS
;
574 to
->to_initval
= NFS_DEF_UDP_TIMEO
* HZ
/ 10;
575 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
576 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
577 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
578 to
->to_exponential
= 1;
586 * Create an RPC client handle
588 int nfs_create_rpc_client(struct nfs_client
*clp
,
589 const struct rpc_timeout
*timeparms
,
590 rpc_authflavor_t flavor
)
592 struct rpc_clnt
*clnt
= NULL
;
593 struct rpc_create_args args
= {
595 .protocol
= clp
->cl_proto
,
596 .address
= (struct sockaddr
*)&clp
->cl_addr
,
597 .addrsize
= clp
->cl_addrlen
,
598 .timeout
= timeparms
,
599 .servername
= clp
->cl_hostname
,
600 .program
= &nfs_program
,
601 .version
= clp
->rpc_ops
->version
,
602 .authflavor
= flavor
,
605 if (test_bit(NFS_CS_DISCRTRY
, &clp
->cl_flags
))
606 args
.flags
|= RPC_CLNT_CREATE_DISCRTRY
;
607 if (test_bit(NFS_CS_NORESVPORT
, &clp
->cl_flags
))
608 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
610 if (!IS_ERR(clp
->cl_rpcclient
))
613 clnt
= rpc_create(&args
);
615 dprintk("%s: cannot create RPC client. Error = %ld\n",
616 __func__
, PTR_ERR(clnt
));
617 return PTR_ERR(clnt
);
620 clp
->cl_rpcclient
= clnt
;
625 * Version 2 or 3 client destruction
627 static void nfs_destroy_server(struct nfs_server
*server
)
629 if (!(server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) ||
630 !(server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
631 nlmclnt_done(server
->nlm_host
);
635 * Version 2 or 3 lockd setup
637 static int nfs_start_lockd(struct nfs_server
*server
)
639 struct nlm_host
*host
;
640 struct nfs_client
*clp
= server
->nfs_client
;
641 struct nlmclnt_initdata nlm_init
= {
642 .hostname
= clp
->cl_hostname
,
643 .address
= (struct sockaddr
*)&clp
->cl_addr
,
644 .addrlen
= clp
->cl_addrlen
,
645 .nfs_version
= clp
->rpc_ops
->version
,
646 .noresvport
= server
->flags
& NFS_MOUNT_NORESVPORT
?
651 if (nlm_init
.nfs_version
> 3)
653 if ((server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) &&
654 (server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
657 switch (clp
->cl_proto
) {
659 nlm_init
.protocol
= IPPROTO_TCP
;
661 case XPRT_TRANSPORT_UDP
:
662 nlm_init
.protocol
= IPPROTO_UDP
;
665 host
= nlmclnt_init(&nlm_init
);
667 return PTR_ERR(host
);
669 server
->nlm_host
= host
;
670 server
->destroy
= nfs_destroy_server
;
675 * Create a general RPC client
677 int nfs_init_server_rpcclient(struct nfs_server
*server
,
678 const struct rpc_timeout
*timeo
,
679 rpc_authflavor_t pseudoflavour
)
681 struct nfs_client
*clp
= server
->nfs_client
;
683 server
->client
= rpc_clone_client(clp
->cl_rpcclient
);
684 if (IS_ERR(server
->client
)) {
685 dprintk("%s: couldn't create rpc_client!\n", __func__
);
686 return PTR_ERR(server
->client
);
689 memcpy(&server
->client
->cl_timeout_default
,
691 sizeof(server
->client
->cl_timeout_default
));
692 server
->client
->cl_timeout
= &server
->client
->cl_timeout_default
;
694 if (pseudoflavour
!= clp
->cl_rpcclient
->cl_auth
->au_flavor
) {
695 struct rpc_auth
*auth
;
697 auth
= rpcauth_create(pseudoflavour
, server
->client
);
699 dprintk("%s: couldn't create credcache!\n", __func__
);
700 return PTR_ERR(auth
);
703 server
->client
->cl_softrtry
= 0;
704 if (server
->flags
& NFS_MOUNT_SOFT
)
705 server
->client
->cl_softrtry
= 1;
711 * nfs_init_client - Initialise an NFS2 or NFS3 client
713 * @clp: nfs_client to initialise
714 * @timeparms: timeout parameters for underlying RPC transport
715 * @ip_addr: IP presentation address (not used)
716 * @authflavor: authentication flavor for underlying RPC transport
718 * Returns pointer to an NFS client, or an ERR_PTR value.
720 struct nfs_client
*nfs_init_client(struct nfs_client
*clp
,
721 const struct rpc_timeout
*timeparms
,
722 const char *ip_addr
, rpc_authflavor_t authflavour
)
726 if (clp
->cl_cons_state
== NFS_CS_READY
) {
727 /* the client is already initialised */
728 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp
);
733 * Create a client RPC handle for doing FSSTAT with UNIX auth only
734 * - RFC 2623, sec 2.3.2
736 error
= nfs_create_rpc_client(clp
, timeparms
, RPC_AUTH_UNIX
);
739 nfs_mark_client_ready(clp
, NFS_CS_READY
);
743 nfs_mark_client_ready(clp
, error
);
745 dprintk("<-- nfs_init_client() = xerror %d\n", error
);
746 return ERR_PTR(error
);
748 EXPORT_SYMBOL_GPL(nfs_init_client
);
751 * Create a version 2 or 3 client
753 static int nfs_init_server(struct nfs_server
*server
,
754 const struct nfs_parsed_mount_data
*data
,
755 struct nfs_subversion
*nfs_mod
)
757 struct nfs_client_initdata cl_init
= {
758 .hostname
= data
->nfs_server
.hostname
,
759 .addr
= (const struct sockaddr
*)&data
->nfs_server
.address
,
760 .addrlen
= data
->nfs_server
.addrlen
,
762 .proto
= data
->nfs_server
.protocol
,
765 struct rpc_timeout timeparms
;
766 struct nfs_client
*clp
;
769 dprintk("--> nfs_init_server()\n");
771 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
772 data
->timeo
, data
->retrans
);
773 if (data
->flags
& NFS_MOUNT_NORESVPORT
)
774 set_bit(NFS_CS_NORESVPORT
, &cl_init
.init_flags
);
776 /* Allocate or find a client reference we can use */
777 clp
= nfs_get_client(&cl_init
, &timeparms
, NULL
, RPC_AUTH_UNIX
);
779 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp
));
783 server
->nfs_client
= clp
;
785 /* Initialise the client representation from the mount data */
786 server
->flags
= data
->flags
;
787 server
->options
= data
->options
;
788 server
->caps
|= NFS_CAP_HARDLINKS
|NFS_CAP_SYMLINKS
|NFS_CAP_FILEID
|
789 NFS_CAP_MODE
|NFS_CAP_NLINK
|NFS_CAP_OWNER
|NFS_CAP_OWNER_GROUP
|
790 NFS_CAP_ATIME
|NFS_CAP_CTIME
|NFS_CAP_MTIME
|NFS_CAP_CHANGE_ATTR
;
793 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
795 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
797 server
->acregmin
= data
->acregmin
* HZ
;
798 server
->acregmax
= data
->acregmax
* HZ
;
799 server
->acdirmin
= data
->acdirmin
* HZ
;
800 server
->acdirmax
= data
->acdirmax
* HZ
;
802 /* Start lockd here, before we might error out */
803 error
= nfs_start_lockd(server
);
807 server
->port
= data
->nfs_server
.port
;
809 error
= nfs_init_server_rpcclient(server
, &timeparms
, data
->auth_flavors
[0]);
813 /* Preserve the values of mount_server-related mount options */
814 if (data
->mount_server
.addrlen
) {
815 memcpy(&server
->mountd_address
, &data
->mount_server
.address
,
816 data
->mount_server
.addrlen
);
817 server
->mountd_addrlen
= data
->mount_server
.addrlen
;
819 server
->mountd_version
= data
->mount_server
.version
;
820 server
->mountd_port
= data
->mount_server
.port
;
821 server
->mountd_protocol
= data
->mount_server
.protocol
;
823 server
->namelen
= data
->namlen
;
824 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp
);
828 server
->nfs_client
= NULL
;
830 dprintk("<-- nfs_init_server() = xerror %d\n", error
);
835 * Load up the server record from information gained in an fsinfo record
837 static void nfs_server_set_fsinfo(struct nfs_server
*server
,
838 struct nfs_fh
*mntfh
,
839 struct nfs_fsinfo
*fsinfo
)
841 unsigned long max_rpc_payload
;
843 /* Work out a lot of parameters */
844 if (server
->rsize
== 0)
845 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
846 if (server
->wsize
== 0)
847 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
849 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
850 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
851 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
852 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
854 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
855 if (server
->rsize
> max_rpc_payload
)
856 server
->rsize
= max_rpc_payload
;
857 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
858 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
859 server
->rpages
= (server
->rsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
861 server
->backing_dev_info
.name
= "nfs";
862 server
->backing_dev_info
.ra_pages
= server
->rpages
* NFS_MAX_READAHEAD
;
864 if (server
->wsize
> max_rpc_payload
)
865 server
->wsize
= max_rpc_payload
;
866 if (server
->wsize
> NFS_MAX_FILE_IO_SIZE
)
867 server
->wsize
= NFS_MAX_FILE_IO_SIZE
;
868 server
->wpages
= (server
->wsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
869 server
->pnfs_blksize
= fsinfo
->blksize
;
871 server
->wtmult
= nfs_block_bits(fsinfo
->wtmult
, NULL
);
873 server
->dtsize
= nfs_block_size(fsinfo
->dtpref
, NULL
);
874 if (server
->dtsize
> PAGE_CACHE_SIZE
* NFS_MAX_READDIR_PAGES
)
875 server
->dtsize
= PAGE_CACHE_SIZE
* NFS_MAX_READDIR_PAGES
;
876 if (server
->dtsize
> server
->rsize
)
877 server
->dtsize
= server
->rsize
;
879 if (server
->flags
& NFS_MOUNT_NOAC
) {
880 server
->acregmin
= server
->acregmax
= 0;
881 server
->acdirmin
= server
->acdirmax
= 0;
884 server
->maxfilesize
= fsinfo
->maxfilesize
;
886 server
->time_delta
= fsinfo
->time_delta
;
888 /* We're airborne Set socket buffersize */
889 rpc_setbufsize(server
->client
, server
->wsize
+ 100, server
->rsize
+ 100);
893 * Probe filesystem information, including the FSID on v2/v3
895 int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*mntfh
, struct nfs_fattr
*fattr
)
897 struct nfs_fsinfo fsinfo
;
898 struct nfs_client
*clp
= server
->nfs_client
;
901 dprintk("--> nfs_probe_fsinfo()\n");
903 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
904 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
909 fsinfo
.fattr
= fattr
;
910 fsinfo
.layouttype
= 0;
911 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
915 nfs_server_set_fsinfo(server
, mntfh
, &fsinfo
);
917 /* Get some general file system info */
918 if (server
->namelen
== 0) {
919 struct nfs_pathconf pathinfo
;
921 pathinfo
.fattr
= fattr
;
922 nfs_fattr_init(fattr
);
924 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
925 server
->namelen
= pathinfo
.max_namelen
;
928 dprintk("<-- nfs_probe_fsinfo() = 0\n");
932 dprintk("nfs_probe_fsinfo: error = %d\n", -error
);
937 * Copy useful information when duplicating a server record
939 void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
941 target
->flags
= source
->flags
;
942 target
->rsize
= source
->rsize
;
943 target
->wsize
= source
->wsize
;
944 target
->acregmin
= source
->acregmin
;
945 target
->acregmax
= source
->acregmax
;
946 target
->acdirmin
= source
->acdirmin
;
947 target
->acdirmax
= source
->acdirmax
;
948 target
->caps
= source
->caps
;
949 target
->options
= source
->options
;
952 void nfs_server_insert_lists(struct nfs_server
*server
)
954 struct nfs_client
*clp
= server
->nfs_client
;
955 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
957 spin_lock(&nn
->nfs_client_lock
);
958 list_add_tail_rcu(&server
->client_link
, &clp
->cl_superblocks
);
959 list_add_tail(&server
->master_link
, &nn
->nfs_volume_list
);
960 clear_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
961 spin_unlock(&nn
->nfs_client_lock
);
965 static void nfs_server_remove_lists(struct nfs_server
*server
)
967 struct nfs_client
*clp
= server
->nfs_client
;
972 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
973 spin_lock(&nn
->nfs_client_lock
);
974 list_del_rcu(&server
->client_link
);
975 if (list_empty(&clp
->cl_superblocks
))
976 set_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
977 list_del(&server
->master_link
);
978 spin_unlock(&nn
->nfs_client_lock
);
984 * Allocate and initialise a server record
986 struct nfs_server
*nfs_alloc_server(void)
988 struct nfs_server
*server
;
990 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
994 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
996 /* Zero out the NFS state stuff */
997 INIT_LIST_HEAD(&server
->client_link
);
998 INIT_LIST_HEAD(&server
->master_link
);
999 INIT_LIST_HEAD(&server
->delegations
);
1000 INIT_LIST_HEAD(&server
->layouts
);
1001 INIT_LIST_HEAD(&server
->state_owners_lru
);
1003 atomic_set(&server
->active
, 0);
1005 server
->io_stats
= nfs_alloc_iostats();
1006 if (!server
->io_stats
) {
1011 if (bdi_init(&server
->backing_dev_info
)) {
1012 nfs_free_iostats(server
->io_stats
);
1017 ida_init(&server
->openowner_id
);
1018 ida_init(&server
->lockowner_id
);
1019 pnfs_init_server(server
);
1025 * Free up a server record
1027 void nfs_free_server(struct nfs_server
*server
)
1029 dprintk("--> nfs_free_server()\n");
1031 nfs_server_remove_lists(server
);
1033 if (server
->destroy
!= NULL
)
1034 server
->destroy(server
);
1036 if (!IS_ERR(server
->client_acl
))
1037 rpc_shutdown_client(server
->client_acl
);
1038 if (!IS_ERR(server
->client
))
1039 rpc_shutdown_client(server
->client
);
1041 nfs_put_client(server
->nfs_client
);
1043 ida_destroy(&server
->lockowner_id
);
1044 ida_destroy(&server
->openowner_id
);
1045 nfs_free_iostats(server
->io_stats
);
1046 bdi_destroy(&server
->backing_dev_info
);
1048 nfs_release_automount_timer();
1049 dprintk("<-- nfs_free_server()\n");
1053 * Create a version 2 or 3 volume record
1054 * - keyed on server and FSID
1056 struct nfs_server
*nfs_create_server(struct nfs_mount_info
*mount_info
,
1057 struct nfs_subversion
*nfs_mod
)
1059 struct nfs_server
*server
;
1060 struct nfs_fattr
*fattr
;
1063 server
= nfs_alloc_server();
1065 return ERR_PTR(-ENOMEM
);
1068 fattr
= nfs_alloc_fattr();
1072 /* Get a client representation */
1073 error
= nfs_init_server(server
, mount_info
->parsed
, nfs_mod
);
1077 BUG_ON(!server
->nfs_client
);
1078 BUG_ON(!server
->nfs_client
->rpc_ops
);
1079 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1081 /* Probe the root fh to retrieve its FSID */
1082 error
= nfs_probe_fsinfo(server
, mount_info
->mntfh
, fattr
);
1085 if (server
->nfs_client
->rpc_ops
->version
== 3) {
1086 if (server
->namelen
== 0 || server
->namelen
> NFS3_MAXNAMLEN
)
1087 server
->namelen
= NFS3_MAXNAMLEN
;
1088 if (!(mount_info
->parsed
->flags
& NFS_MOUNT_NORDIRPLUS
))
1089 server
->caps
|= NFS_CAP_READDIRPLUS
;
1091 if (server
->namelen
== 0 || server
->namelen
> NFS2_MAXNAMLEN
)
1092 server
->namelen
= NFS2_MAXNAMLEN
;
1095 if (!(fattr
->valid
& NFS_ATTR_FATTR
)) {
1096 error
= nfs_mod
->rpc_ops
->getattr(server
, mount_info
->mntfh
, fattr
);
1098 dprintk("nfs_create_server: getattr error = %d\n", -error
);
1102 memcpy(&server
->fsid
, &fattr
->fsid
, sizeof(server
->fsid
));
1104 dprintk("Server FSID: %llx:%llx\n",
1105 (unsigned long long) server
->fsid
.major
,
1106 (unsigned long long) server
->fsid
.minor
);
1108 nfs_server_insert_lists(server
);
1109 server
->mount_time
= jiffies
;
1110 nfs_free_fattr(fattr
);
1114 nfs_free_fattr(fattr
);
1115 nfs_free_server(server
);
1116 return ERR_PTR(error
);
1118 EXPORT_SYMBOL_GPL(nfs_create_server
);
1121 * Clone an NFS2, NFS3 or NFS4 server record
1123 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
1125 struct nfs_fattr
*fattr
,
1126 rpc_authflavor_t flavor
)
1128 struct nfs_server
*server
;
1129 struct nfs_fattr
*fattr_fsinfo
;
1132 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1133 (unsigned long long) fattr
->fsid
.major
,
1134 (unsigned long long) fattr
->fsid
.minor
);
1136 server
= nfs_alloc_server();
1138 return ERR_PTR(-ENOMEM
);
1141 fattr_fsinfo
= nfs_alloc_fattr();
1142 if (fattr_fsinfo
== NULL
)
1143 goto out_free_server
;
1145 /* Copy data from the source */
1146 server
->nfs_client
= source
->nfs_client
;
1147 server
->destroy
= source
->destroy
;
1148 atomic_inc(&server
->nfs_client
->cl_count
);
1149 nfs_server_copy_userdata(server
, source
);
1151 server
->fsid
= fattr
->fsid
;
1153 error
= nfs_init_server_rpcclient(server
,
1154 source
->client
->cl_timeout
,
1157 goto out_free_server
;
1159 /* probe the filesystem info for this server filesystem */
1160 error
= nfs_probe_fsinfo(server
, fh
, fattr_fsinfo
);
1162 goto out_free_server
;
1164 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1165 server
->namelen
= NFS4_MAXNAMLEN
;
1167 dprintk("Cloned FSID: %llx:%llx\n",
1168 (unsigned long long) server
->fsid
.major
,
1169 (unsigned long long) server
->fsid
.minor
);
1171 error
= nfs_start_lockd(server
);
1173 goto out_free_server
;
1175 nfs_server_insert_lists(server
);
1176 server
->mount_time
= jiffies
;
1178 nfs_free_fattr(fattr_fsinfo
);
1179 dprintk("<-- nfs_clone_server() = %p\n", server
);
1183 nfs_free_fattr(fattr_fsinfo
);
1184 nfs_free_server(server
);
1185 dprintk("<-- nfs_clone_server() = error %d\n", error
);
1186 return ERR_PTR(error
);
1188 EXPORT_SYMBOL_GPL(nfs_clone_server
);
1190 void nfs_clients_init(struct net
*net
)
1192 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1194 INIT_LIST_HEAD(&nn
->nfs_client_list
);
1195 INIT_LIST_HEAD(&nn
->nfs_volume_list
);
1196 #ifdef CONFIG_NFS_V4
1197 idr_init(&nn
->cb_ident_idr
);
1199 spin_lock_init(&nn
->nfs_client_lock
);
1200 nn
->boot_time
= CURRENT_TIME
;
1203 #ifdef CONFIG_PROC_FS
1204 static struct proc_dir_entry
*proc_fs_nfs
;
1206 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
);
1207 static void *nfs_server_list_start(struct seq_file
*p
, loff_t
*pos
);
1208 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1209 static void nfs_server_list_stop(struct seq_file
*p
, void *v
);
1210 static int nfs_server_list_show(struct seq_file
*m
, void *v
);
1212 static const struct seq_operations nfs_server_list_ops
= {
1213 .start
= nfs_server_list_start
,
1214 .next
= nfs_server_list_next
,
1215 .stop
= nfs_server_list_stop
,
1216 .show
= nfs_server_list_show
,
1219 static const struct file_operations nfs_server_list_fops
= {
1220 .open
= nfs_server_list_open
,
1222 .llseek
= seq_lseek
,
1223 .release
= seq_release
,
1224 .owner
= THIS_MODULE
,
1227 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
);
1228 static void *nfs_volume_list_start(struct seq_file
*p
, loff_t
*pos
);
1229 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1230 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
);
1231 static int nfs_volume_list_show(struct seq_file
*m
, void *v
);
1233 static const struct seq_operations nfs_volume_list_ops
= {
1234 .start
= nfs_volume_list_start
,
1235 .next
= nfs_volume_list_next
,
1236 .stop
= nfs_volume_list_stop
,
1237 .show
= nfs_volume_list_show
,
1240 static const struct file_operations nfs_volume_list_fops
= {
1241 .open
= nfs_volume_list_open
,
1243 .llseek
= seq_lseek
,
1244 .release
= seq_release
,
1245 .owner
= THIS_MODULE
,
1249 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1252 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
)
1256 struct pid_namespace
*pid_ns
= file
->f_dentry
->d_sb
->s_fs_info
;
1257 struct net
*net
= pid_ns
->child_reaper
->nsproxy
->net_ns
;
1259 ret
= seq_open(file
, &nfs_server_list_ops
);
1263 m
= file
->private_data
;
1270 * set up the iterator to start reading from the server list and return the first item
1272 static void *nfs_server_list_start(struct seq_file
*m
, loff_t
*_pos
)
1274 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1276 /* lock the list against modification */
1277 spin_lock(&nn
->nfs_client_lock
);
1278 return seq_list_start_head(&nn
->nfs_client_list
, *_pos
);
1282 * move to next server
1284 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1286 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1288 return seq_list_next(v
, &nn
->nfs_client_list
, pos
);
1292 * clean up after reading from the transports list
1294 static void nfs_server_list_stop(struct seq_file
*p
, void *v
)
1296 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1298 spin_unlock(&nn
->nfs_client_lock
);
1302 * display a header line followed by a load of call lines
1304 static int nfs_server_list_show(struct seq_file
*m
, void *v
)
1306 struct nfs_client
*clp
;
1307 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1309 /* display header on line 1 */
1310 if (v
== &nn
->nfs_client_list
) {
1311 seq_puts(m
, "NV SERVER PORT USE HOSTNAME\n");
1315 /* display one transport per line on subsequent lines */
1316 clp
= list_entry(v
, struct nfs_client
, cl_share_link
);
1318 /* Check if the client is initialized */
1319 if (clp
->cl_cons_state
!= NFS_CS_READY
)
1323 seq_printf(m
, "v%u %s %s %3d %s\n",
1324 clp
->rpc_ops
->version
,
1325 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1326 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1327 atomic_read(&clp
->cl_count
),
1335 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1337 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
)
1341 struct pid_namespace
*pid_ns
= file
->f_dentry
->d_sb
->s_fs_info
;
1342 struct net
*net
= pid_ns
->child_reaper
->nsproxy
->net_ns
;
1344 ret
= seq_open(file
, &nfs_volume_list_ops
);
1348 m
= file
->private_data
;
1355 * set up the iterator to start reading from the volume list and return the first item
1357 static void *nfs_volume_list_start(struct seq_file
*m
, loff_t
*_pos
)
1359 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1361 /* lock the list against modification */
1362 spin_lock(&nn
->nfs_client_lock
);
1363 return seq_list_start_head(&nn
->nfs_volume_list
, *_pos
);
1367 * move to next volume
1369 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1371 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1373 return seq_list_next(v
, &nn
->nfs_volume_list
, pos
);
1377 * clean up after reading from the transports list
1379 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
)
1381 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1383 spin_unlock(&nn
->nfs_client_lock
);
1387 * display a header line followed by a load of call lines
1389 static int nfs_volume_list_show(struct seq_file
*m
, void *v
)
1391 struct nfs_server
*server
;
1392 struct nfs_client
*clp
;
1393 char dev
[8], fsid
[17];
1394 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1396 /* display header on line 1 */
1397 if (v
== &nn
->nfs_volume_list
) {
1398 seq_puts(m
, "NV SERVER PORT DEV FSID FSC\n");
1401 /* display one transport per line on subsequent lines */
1402 server
= list_entry(v
, struct nfs_server
, master_link
);
1403 clp
= server
->nfs_client
;
1405 snprintf(dev
, 8, "%u:%u",
1406 MAJOR(server
->s_dev
), MINOR(server
->s_dev
));
1408 snprintf(fsid
, 17, "%llx:%llx",
1409 (unsigned long long) server
->fsid
.major
,
1410 (unsigned long long) server
->fsid
.minor
);
1413 seq_printf(m
, "v%u %s %s %-7s %-17s %s\n",
1414 clp
->rpc_ops
->version
,
1415 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1416 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1419 nfs_server_fscache_state(server
));
1426 * initialise the /proc/fs/nfsfs/ directory
1428 int __init
nfs_fs_proc_init(void)
1430 struct proc_dir_entry
*p
;
1432 proc_fs_nfs
= proc_mkdir("fs/nfsfs", NULL
);
1436 /* a file of servers with which we're dealing */
1437 p
= proc_create("servers", S_IFREG
|S_IRUGO
,
1438 proc_fs_nfs
, &nfs_server_list_fops
);
1442 /* a file of volumes that we have mounted */
1443 p
= proc_create("volumes", S_IFREG
|S_IRUGO
,
1444 proc_fs_nfs
, &nfs_volume_list_fops
);
1450 remove_proc_entry("servers", proc_fs_nfs
);
1452 remove_proc_entry("fs/nfsfs", NULL
);
1458 * clean up the /proc/fs/nfsfs/ directory
1460 void nfs_fs_proc_exit(void)
1462 remove_proc_entry("volumes", proc_fs_nfs
);
1463 remove_proc_entry("servers", proc_fs_nfs
);
1464 remove_proc_entry("fs/nfsfs", NULL
);
1467 #endif /* CONFIG_PROC_FS */