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("nfsv%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 * 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 try_module_get(clp
->cl_nfs_mod
->owner
);
163 clp
->rpc_ops
= clp
->cl_nfs_mod
->rpc_ops
;
165 atomic_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 cred
= rpc_lookup_machine_cred("*");
186 clp
->cl_machine_cred
= cred
;
187 nfs_fscache_get_client_cookie(clp
);
192 put_nfs_version(clp
->cl_nfs_mod
);
197 EXPORT_SYMBOL_GPL(nfs_alloc_client
);
199 #if IS_ENABLED(CONFIG_NFS_V4)
200 void nfs_cleanup_cb_ident_idr(struct net
*net
)
202 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
204 idr_destroy(&nn
->cb_ident_idr
);
207 /* nfs_client_lock held */
208 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
210 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
212 if (clp
->cl_cb_ident
)
213 idr_remove(&nn
->cb_ident_idr
, clp
->cl_cb_ident
);
216 static void pnfs_init_server(struct nfs_server
*server
)
218 rpc_init_wait_queue(&server
->roc_rpcwaitq
, "pNFS ROC");
222 void nfs_cleanup_cb_ident_idr(struct net
*net
)
226 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
230 static void pnfs_init_server(struct nfs_server
*server
)
234 #endif /* CONFIG_NFS_V4 */
237 * Destroy a shared client record
239 void nfs_free_client(struct nfs_client
*clp
)
241 dprintk("--> nfs_free_client(%u)\n", clp
->rpc_ops
->version
);
243 nfs_fscache_release_client_cookie(clp
);
245 /* -EIO all pending I/O */
246 if (!IS_ERR(clp
->cl_rpcclient
))
247 rpc_shutdown_client(clp
->cl_rpcclient
);
249 if (clp
->cl_machine_cred
!= NULL
)
250 put_rpccred(clp
->cl_machine_cred
);
252 put_net(clp
->cl_net
);
253 put_nfs_version(clp
->cl_nfs_mod
);
254 kfree(clp
->cl_hostname
);
257 dprintk("<-- nfs_free_client()\n");
259 EXPORT_SYMBOL_GPL(nfs_free_client
);
262 * Release a reference to a shared client record
264 void nfs_put_client(struct nfs_client
*clp
)
271 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp
->cl_count
));
272 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
274 if (atomic_dec_and_lock(&clp
->cl_count
, &nn
->nfs_client_lock
)) {
275 list_del(&clp
->cl_share_link
);
276 nfs_cb_idr_remove_locked(clp
);
277 spin_unlock(&nn
->nfs_client_lock
);
279 WARN_ON_ONCE(!list_empty(&clp
->cl_superblocks
));
281 clp
->rpc_ops
->free_client(clp
);
284 EXPORT_SYMBOL_GPL(nfs_put_client
);
286 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
288 * Test if two ip6 socket addresses refer to the same socket by
289 * comparing relevant fields. The padding bytes specifically, are not
290 * compared. sin6_flowinfo is not compared because it only affects QoS
291 * and sin6_scope_id is only compared if the address is "link local"
292 * because "link local" addresses need only be unique to a specific
293 * link. Conversely, ordinary unicast addresses might have different
296 * The caller should ensure both socket addresses are AF_INET6.
298 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr
*sa1
,
299 const struct sockaddr
*sa2
)
301 const struct sockaddr_in6
*sin1
= (const struct sockaddr_in6
*)sa1
;
302 const struct sockaddr_in6
*sin2
= (const struct sockaddr_in6
*)sa2
;
304 if (!ipv6_addr_equal(&sin1
->sin6_addr
, &sin2
->sin6_addr
))
306 else if (ipv6_addr_type(&sin1
->sin6_addr
) & IPV6_ADDR_LINKLOCAL
)
307 return sin1
->sin6_scope_id
== sin2
->sin6_scope_id
;
311 #else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
312 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr
*sa1
,
313 const struct sockaddr
*sa2
)
320 * Test if two ip4 socket addresses refer to the same socket, by
321 * comparing relevant fields. The padding bytes specifically, are
324 * The caller should ensure both socket addresses are AF_INET.
326 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr
*sa1
,
327 const struct sockaddr
*sa2
)
329 const struct sockaddr_in
*sin1
= (const struct sockaddr_in
*)sa1
;
330 const struct sockaddr_in
*sin2
= (const struct sockaddr_in
*)sa2
;
332 return sin1
->sin_addr
.s_addr
== sin2
->sin_addr
.s_addr
;
335 static int nfs_sockaddr_cmp_ip6(const struct sockaddr
*sa1
,
336 const struct sockaddr
*sa2
)
338 const struct sockaddr_in6
*sin1
= (const struct sockaddr_in6
*)sa1
;
339 const struct sockaddr_in6
*sin2
= (const struct sockaddr_in6
*)sa2
;
341 return nfs_sockaddr_match_ipaddr6(sa1
, sa2
) &&
342 (sin1
->sin6_port
== sin2
->sin6_port
);
345 static int nfs_sockaddr_cmp_ip4(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 nfs_sockaddr_match_ipaddr4(sa1
, sa2
) &&
352 (sin1
->sin_port
== sin2
->sin_port
);
355 #if defined(CONFIG_NFS_V4_1)
357 * Test if two socket addresses represent the same actual socket,
358 * by comparing (only) relevant fields, excluding the port number.
360 int nfs_sockaddr_match_ipaddr(const struct sockaddr
*sa1
,
361 const struct sockaddr
*sa2
)
363 if (sa1
->sa_family
!= sa2
->sa_family
)
366 switch (sa1
->sa_family
) {
368 return nfs_sockaddr_match_ipaddr4(sa1
, sa2
);
370 return nfs_sockaddr_match_ipaddr6(sa1
, sa2
);
374 EXPORT_SYMBOL_GPL(nfs_sockaddr_match_ipaddr
);
375 #endif /* CONFIG_NFS_V4_1 */
378 * Test if two socket addresses represent the same actual socket,
379 * by comparing (only) relevant fields, including the port number.
381 static int nfs_sockaddr_cmp(const struct sockaddr
*sa1
,
382 const struct sockaddr
*sa2
)
384 if (sa1
->sa_family
!= sa2
->sa_family
)
387 switch (sa1
->sa_family
) {
389 return nfs_sockaddr_cmp_ip4(sa1
, sa2
);
391 return nfs_sockaddr_cmp_ip6(sa1
, sa2
);
397 * Find an nfs_client on the list that matches the initialisation data
400 static struct nfs_client
*nfs_match_client(const struct nfs_client_initdata
*data
)
402 struct nfs_client
*clp
;
403 const struct sockaddr
*sap
= data
->addr
;
404 struct nfs_net
*nn
= net_generic(data
->net
, nfs_net_id
);
406 list_for_each_entry(clp
, &nn
->nfs_client_list
, cl_share_link
) {
407 const struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
408 /* Don't match clients that failed to initialise properly */
409 if (clp
->cl_cons_state
< 0)
412 /* Different NFS versions cannot share the same nfs_client */
413 if (clp
->rpc_ops
!= data
->nfs_mod
->rpc_ops
)
416 if (clp
->cl_proto
!= data
->proto
)
418 /* Match nfsv4 minorversion */
419 if (clp
->cl_minorversion
!= data
->minorversion
)
421 /* Match the full socket address */
422 if (!nfs_sockaddr_cmp(sap
, clap
))
425 atomic_inc(&clp
->cl_count
);
431 static bool nfs_client_init_is_complete(const struct nfs_client
*clp
)
433 return clp
->cl_cons_state
!= NFS_CS_INITING
;
436 int nfs_wait_client_init_complete(const struct nfs_client
*clp
)
438 return wait_event_killable(nfs_client_active_wq
,
439 nfs_client_init_is_complete(clp
));
441 EXPORT_SYMBOL_GPL(nfs_wait_client_init_complete
);
444 * Found an existing client. Make sure it's ready before returning.
446 static struct nfs_client
*
447 nfs_found_client(const struct nfs_client_initdata
*cl_init
,
448 struct nfs_client
*clp
)
452 error
= nfs_wait_client_init_complete(clp
);
455 return ERR_PTR(-ERESTARTSYS
);
458 if (clp
->cl_cons_state
< NFS_CS_READY
) {
459 error
= clp
->cl_cons_state
;
461 return ERR_PTR(error
);
466 dprintk("<-- %s found nfs_client %p for %s\n",
467 __func__
, clp
, cl_init
->hostname
?: "");
472 * Look up a client by IP address and protocol version
473 * - creates a new record if one doesn't yet exist
476 nfs_get_client(const struct nfs_client_initdata
*cl_init
,
477 const struct rpc_timeout
*timeparms
,
479 rpc_authflavor_t authflavour
)
481 struct nfs_client
*clp
, *new = NULL
;
482 struct nfs_net
*nn
= net_generic(cl_init
->net
, nfs_net_id
);
483 const struct nfs_rpc_ops
*rpc_ops
= cl_init
->nfs_mod
->rpc_ops
;
485 dprintk("--> nfs_get_client(%s,v%u)\n",
486 cl_init
->hostname
?: "", rpc_ops
->version
);
488 /* see if the client already exists */
490 spin_lock(&nn
->nfs_client_lock
);
492 clp
= nfs_match_client(cl_init
);
494 spin_unlock(&nn
->nfs_client_lock
);
496 new->rpc_ops
->free_client(new);
497 return nfs_found_client(cl_init
, clp
);
500 list_add_tail(&new->cl_share_link
,
501 &nn
->nfs_client_list
);
502 spin_unlock(&nn
->nfs_client_lock
);
503 new->cl_flags
= cl_init
->init_flags
;
504 return rpc_ops
->init_client(new, timeparms
, ip_addr
);
507 spin_unlock(&nn
->nfs_client_lock
);
509 new = rpc_ops
->alloc_client(cl_init
);
510 } while (!IS_ERR(new));
512 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
513 cl_init
->hostname
?: "", PTR_ERR(new));
516 EXPORT_SYMBOL_GPL(nfs_get_client
);
519 * Mark a server as ready or failed
521 void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
524 clp
->cl_cons_state
= state
;
525 wake_up_all(&nfs_client_active_wq
);
527 EXPORT_SYMBOL_GPL(nfs_mark_client_ready
);
530 * Initialise the timeout values for a connection
532 void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
533 unsigned int timeo
, unsigned int retrans
)
535 to
->to_initval
= timeo
* HZ
/ 10;
536 to
->to_retries
= retrans
;
539 case XPRT_TRANSPORT_TCP
:
540 case XPRT_TRANSPORT_RDMA
:
541 if (to
->to_retries
== 0)
542 to
->to_retries
= NFS_DEF_TCP_RETRANS
;
543 if (to
->to_initval
== 0)
544 to
->to_initval
= NFS_DEF_TCP_TIMEO
* HZ
/ 10;
545 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
546 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
547 to
->to_increment
= to
->to_initval
;
548 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
549 if (to
->to_maxval
> NFS_MAX_TCP_TIMEOUT
)
550 to
->to_maxval
= NFS_MAX_TCP_TIMEOUT
;
551 if (to
->to_maxval
< to
->to_initval
)
552 to
->to_maxval
= to
->to_initval
;
553 to
->to_exponential
= 0;
555 case XPRT_TRANSPORT_UDP
:
556 if (to
->to_retries
== 0)
557 to
->to_retries
= NFS_DEF_UDP_RETRANS
;
559 to
->to_initval
= NFS_DEF_UDP_TIMEO
* HZ
/ 10;
560 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
561 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
562 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
563 to
->to_exponential
= 1;
569 EXPORT_SYMBOL_GPL(nfs_init_timeout_values
);
572 * Create an RPC client handle
574 int nfs_create_rpc_client(struct nfs_client
*clp
,
575 const struct rpc_timeout
*timeparms
,
576 rpc_authflavor_t flavor
)
578 struct rpc_clnt
*clnt
= NULL
;
579 struct rpc_create_args args
= {
581 .protocol
= clp
->cl_proto
,
582 .address
= (struct sockaddr
*)&clp
->cl_addr
,
583 .addrsize
= clp
->cl_addrlen
,
584 .timeout
= timeparms
,
585 .servername
= clp
->cl_hostname
,
586 .program
= &nfs_program
,
587 .version
= clp
->rpc_ops
->version
,
588 .authflavor
= flavor
,
591 if (test_bit(NFS_CS_DISCRTRY
, &clp
->cl_flags
))
592 args
.flags
|= RPC_CLNT_CREATE_DISCRTRY
;
593 if (test_bit(NFS_CS_NORESVPORT
, &clp
->cl_flags
))
594 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
595 if (test_bit(NFS_CS_INFINITE_SLOTS
, &clp
->cl_flags
))
596 args
.flags
|= RPC_CLNT_CREATE_INFINITE_SLOTS
;
598 if (!IS_ERR(clp
->cl_rpcclient
))
601 clnt
= rpc_create(&args
);
603 dprintk("%s: cannot create RPC client. Error = %ld\n",
604 __func__
, PTR_ERR(clnt
));
605 return PTR_ERR(clnt
);
608 clp
->cl_rpcclient
= clnt
;
611 EXPORT_SYMBOL_GPL(nfs_create_rpc_client
);
614 * Version 2 or 3 client destruction
616 static void nfs_destroy_server(struct nfs_server
*server
)
618 if (server
->nlm_host
)
619 nlmclnt_done(server
->nlm_host
);
623 * Version 2 or 3 lockd setup
625 static int nfs_start_lockd(struct nfs_server
*server
)
627 struct nlm_host
*host
;
628 struct nfs_client
*clp
= server
->nfs_client
;
629 struct nlmclnt_initdata nlm_init
= {
630 .hostname
= clp
->cl_hostname
,
631 .address
= (struct sockaddr
*)&clp
->cl_addr
,
632 .addrlen
= clp
->cl_addrlen
,
633 .nfs_version
= clp
->rpc_ops
->version
,
634 .noresvport
= server
->flags
& NFS_MOUNT_NORESVPORT
?
639 if (nlm_init
.nfs_version
> 3)
641 if ((server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) &&
642 (server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
645 switch (clp
->cl_proto
) {
647 nlm_init
.protocol
= IPPROTO_TCP
;
649 case XPRT_TRANSPORT_UDP
:
650 nlm_init
.protocol
= IPPROTO_UDP
;
653 host
= nlmclnt_init(&nlm_init
);
655 return PTR_ERR(host
);
657 server
->nlm_host
= host
;
658 server
->destroy
= nfs_destroy_server
;
663 * Create a general RPC client
665 int nfs_init_server_rpcclient(struct nfs_server
*server
,
666 const struct rpc_timeout
*timeo
,
667 rpc_authflavor_t pseudoflavour
)
669 struct nfs_client
*clp
= server
->nfs_client
;
671 server
->client
= rpc_clone_client_set_auth(clp
->cl_rpcclient
,
673 if (IS_ERR(server
->client
)) {
674 dprintk("%s: couldn't create rpc_client!\n", __func__
);
675 return PTR_ERR(server
->client
);
678 memcpy(&server
->client
->cl_timeout_default
,
680 sizeof(server
->client
->cl_timeout_default
));
681 server
->client
->cl_timeout
= &server
->client
->cl_timeout_default
;
682 server
->client
->cl_softrtry
= 0;
683 if (server
->flags
& NFS_MOUNT_SOFT
)
684 server
->client
->cl_softrtry
= 1;
688 EXPORT_SYMBOL_GPL(nfs_init_server_rpcclient
);
691 * nfs_init_client - Initialise an NFS2 or NFS3 client
693 * @clp: nfs_client to initialise
694 * @timeparms: timeout parameters for underlying RPC transport
695 * @ip_addr: IP presentation address (not used)
697 * Returns pointer to an NFS client, or an ERR_PTR value.
699 struct nfs_client
*nfs_init_client(struct nfs_client
*clp
,
700 const struct rpc_timeout
*timeparms
,
705 if (clp
->cl_cons_state
== NFS_CS_READY
) {
706 /* the client is already initialised */
707 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp
);
712 * Create a client RPC handle for doing FSSTAT with UNIX auth only
713 * - RFC 2623, sec 2.3.2
715 error
= nfs_create_rpc_client(clp
, timeparms
, RPC_AUTH_UNIX
);
718 nfs_mark_client_ready(clp
, NFS_CS_READY
);
722 nfs_mark_client_ready(clp
, error
);
724 dprintk("<-- nfs_init_client() = xerror %d\n", error
);
725 return ERR_PTR(error
);
727 EXPORT_SYMBOL_GPL(nfs_init_client
);
730 * Create a version 2 or 3 client
732 static int nfs_init_server(struct nfs_server
*server
,
733 const struct nfs_parsed_mount_data
*data
,
734 struct nfs_subversion
*nfs_mod
)
736 struct nfs_client_initdata cl_init
= {
737 .hostname
= data
->nfs_server
.hostname
,
738 .addr
= (const struct sockaddr
*)&data
->nfs_server
.address
,
739 .addrlen
= data
->nfs_server
.addrlen
,
741 .proto
= data
->nfs_server
.protocol
,
744 struct rpc_timeout timeparms
;
745 struct nfs_client
*clp
;
748 dprintk("--> nfs_init_server()\n");
750 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
751 data
->timeo
, data
->retrans
);
752 if (data
->flags
& NFS_MOUNT_NORESVPORT
)
753 set_bit(NFS_CS_NORESVPORT
, &cl_init
.init_flags
);
755 /* Allocate or find a client reference we can use */
756 clp
= nfs_get_client(&cl_init
, &timeparms
, NULL
, RPC_AUTH_UNIX
);
758 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp
));
762 server
->nfs_client
= clp
;
764 /* Initialise the client representation from the mount data */
765 server
->flags
= data
->flags
;
766 server
->options
= data
->options
;
767 server
->caps
|= NFS_CAP_HARDLINKS
|NFS_CAP_SYMLINKS
|NFS_CAP_FILEID
|
768 NFS_CAP_MODE
|NFS_CAP_NLINK
|NFS_CAP_OWNER
|NFS_CAP_OWNER_GROUP
|
769 NFS_CAP_ATIME
|NFS_CAP_CTIME
|NFS_CAP_MTIME
|NFS_CAP_CHANGE_ATTR
;
772 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
774 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
776 server
->acregmin
= data
->acregmin
* HZ
;
777 server
->acregmax
= data
->acregmax
* HZ
;
778 server
->acdirmin
= data
->acdirmin
* HZ
;
779 server
->acdirmax
= data
->acdirmax
* HZ
;
781 /* Start lockd here, before we might error out */
782 error
= nfs_start_lockd(server
);
786 server
->port
= data
->nfs_server
.port
;
788 error
= nfs_init_server_rpcclient(server
, &timeparms
, data
->auth_flavors
[0]);
792 /* Preserve the values of mount_server-related mount options */
793 if (data
->mount_server
.addrlen
) {
794 memcpy(&server
->mountd_address
, &data
->mount_server
.address
,
795 data
->mount_server
.addrlen
);
796 server
->mountd_addrlen
= data
->mount_server
.addrlen
;
798 server
->mountd_version
= data
->mount_server
.version
;
799 server
->mountd_port
= data
->mount_server
.port
;
800 server
->mountd_protocol
= data
->mount_server
.protocol
;
802 server
->namelen
= data
->namlen
;
803 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp
);
807 server
->nfs_client
= NULL
;
809 dprintk("<-- nfs_init_server() = xerror %d\n", error
);
814 * Load up the server record from information gained in an fsinfo record
816 static void nfs_server_set_fsinfo(struct nfs_server
*server
,
817 struct nfs_fh
*mntfh
,
818 struct nfs_fsinfo
*fsinfo
)
820 unsigned long max_rpc_payload
;
822 /* Work out a lot of parameters */
823 if (server
->rsize
== 0)
824 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
825 if (server
->wsize
== 0)
826 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
828 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
829 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
830 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
831 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
833 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
834 if (server
->rsize
> max_rpc_payload
)
835 server
->rsize
= max_rpc_payload
;
836 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
837 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
838 server
->rpages
= (server
->rsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
840 server
->backing_dev_info
.name
= "nfs";
841 server
->backing_dev_info
.ra_pages
= server
->rpages
* NFS_MAX_READAHEAD
;
843 if (server
->wsize
> max_rpc_payload
)
844 server
->wsize
= max_rpc_payload
;
845 if (server
->wsize
> NFS_MAX_FILE_IO_SIZE
)
846 server
->wsize
= NFS_MAX_FILE_IO_SIZE
;
847 server
->wpages
= (server
->wsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
849 server
->wtmult
= nfs_block_bits(fsinfo
->wtmult
, NULL
);
851 server
->dtsize
= nfs_block_size(fsinfo
->dtpref
, NULL
);
852 if (server
->dtsize
> PAGE_CACHE_SIZE
* NFS_MAX_READDIR_PAGES
)
853 server
->dtsize
= PAGE_CACHE_SIZE
* NFS_MAX_READDIR_PAGES
;
854 if (server
->dtsize
> server
->rsize
)
855 server
->dtsize
= server
->rsize
;
857 if (server
->flags
& NFS_MOUNT_NOAC
) {
858 server
->acregmin
= server
->acregmax
= 0;
859 server
->acdirmin
= server
->acdirmax
= 0;
862 server
->maxfilesize
= fsinfo
->maxfilesize
;
864 server
->time_delta
= fsinfo
->time_delta
;
866 /* We're airborne Set socket buffersize */
867 rpc_setbufsize(server
->client
, server
->wsize
+ 100, server
->rsize
+ 100);
871 * Probe filesystem information, including the FSID on v2/v3
873 int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*mntfh
, struct nfs_fattr
*fattr
)
875 struct nfs_fsinfo fsinfo
;
876 struct nfs_client
*clp
= server
->nfs_client
;
879 dprintk("--> nfs_probe_fsinfo()\n");
881 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
882 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
887 fsinfo
.fattr
= fattr
;
888 fsinfo
.layouttype
= 0;
889 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
893 nfs_server_set_fsinfo(server
, mntfh
, &fsinfo
);
895 /* Get some general file system info */
896 if (server
->namelen
== 0) {
897 struct nfs_pathconf pathinfo
;
899 pathinfo
.fattr
= fattr
;
900 nfs_fattr_init(fattr
);
902 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
903 server
->namelen
= pathinfo
.max_namelen
;
906 dprintk("<-- nfs_probe_fsinfo() = 0\n");
910 dprintk("nfs_probe_fsinfo: error = %d\n", -error
);
913 EXPORT_SYMBOL_GPL(nfs_probe_fsinfo
);
916 * Copy useful information when duplicating a server record
918 void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
920 target
->flags
= source
->flags
;
921 target
->rsize
= source
->rsize
;
922 target
->wsize
= source
->wsize
;
923 target
->acregmin
= source
->acregmin
;
924 target
->acregmax
= source
->acregmax
;
925 target
->acdirmin
= source
->acdirmin
;
926 target
->acdirmax
= source
->acdirmax
;
927 target
->caps
= source
->caps
;
928 target
->options
= source
->options
;
930 EXPORT_SYMBOL_GPL(nfs_server_copy_userdata
);
932 void nfs_server_insert_lists(struct nfs_server
*server
)
934 struct nfs_client
*clp
= server
->nfs_client
;
935 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
937 spin_lock(&nn
->nfs_client_lock
);
938 list_add_tail_rcu(&server
->client_link
, &clp
->cl_superblocks
);
939 list_add_tail(&server
->master_link
, &nn
->nfs_volume_list
);
940 clear_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
941 spin_unlock(&nn
->nfs_client_lock
);
944 EXPORT_SYMBOL_GPL(nfs_server_insert_lists
);
946 static void nfs_server_remove_lists(struct nfs_server
*server
)
948 struct nfs_client
*clp
= server
->nfs_client
;
953 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
954 spin_lock(&nn
->nfs_client_lock
);
955 list_del_rcu(&server
->client_link
);
956 if (list_empty(&clp
->cl_superblocks
))
957 set_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
958 list_del(&server
->master_link
);
959 spin_unlock(&nn
->nfs_client_lock
);
965 * Allocate and initialise a server record
967 struct nfs_server
*nfs_alloc_server(void)
969 struct nfs_server
*server
;
971 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
975 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
977 /* Zero out the NFS state stuff */
978 INIT_LIST_HEAD(&server
->client_link
);
979 INIT_LIST_HEAD(&server
->master_link
);
980 INIT_LIST_HEAD(&server
->delegations
);
981 INIT_LIST_HEAD(&server
->layouts
);
982 INIT_LIST_HEAD(&server
->state_owners_lru
);
984 atomic_set(&server
->active
, 0);
986 server
->io_stats
= nfs_alloc_iostats();
987 if (!server
->io_stats
) {
992 if (bdi_init(&server
->backing_dev_info
)) {
993 nfs_free_iostats(server
->io_stats
);
998 ida_init(&server
->openowner_id
);
999 ida_init(&server
->lockowner_id
);
1000 pnfs_init_server(server
);
1004 EXPORT_SYMBOL_GPL(nfs_alloc_server
);
1007 * Free up a server record
1009 void nfs_free_server(struct nfs_server
*server
)
1011 dprintk("--> nfs_free_server()\n");
1013 nfs_server_remove_lists(server
);
1015 if (server
->destroy
!= NULL
)
1016 server
->destroy(server
);
1018 if (!IS_ERR(server
->client_acl
))
1019 rpc_shutdown_client(server
->client_acl
);
1020 if (!IS_ERR(server
->client
))
1021 rpc_shutdown_client(server
->client
);
1023 nfs_put_client(server
->nfs_client
);
1025 ida_destroy(&server
->lockowner_id
);
1026 ida_destroy(&server
->openowner_id
);
1027 nfs_free_iostats(server
->io_stats
);
1028 bdi_destroy(&server
->backing_dev_info
);
1030 nfs_release_automount_timer();
1031 dprintk("<-- nfs_free_server()\n");
1033 EXPORT_SYMBOL_GPL(nfs_free_server
);
1036 * Create a version 2 or 3 volume record
1037 * - keyed on server and FSID
1039 struct nfs_server
*nfs_create_server(struct nfs_mount_info
*mount_info
,
1040 struct nfs_subversion
*nfs_mod
)
1042 struct nfs_server
*server
;
1043 struct nfs_fattr
*fattr
;
1046 server
= nfs_alloc_server();
1048 return ERR_PTR(-ENOMEM
);
1051 fattr
= nfs_alloc_fattr();
1055 /* Get a client representation */
1056 error
= nfs_init_server(server
, mount_info
->parsed
, nfs_mod
);
1060 /* Probe the root fh to retrieve its FSID */
1061 error
= nfs_probe_fsinfo(server
, mount_info
->mntfh
, fattr
);
1064 if (server
->nfs_client
->rpc_ops
->version
== 3) {
1065 if (server
->namelen
== 0 || server
->namelen
> NFS3_MAXNAMLEN
)
1066 server
->namelen
= NFS3_MAXNAMLEN
;
1067 if (!(mount_info
->parsed
->flags
& NFS_MOUNT_NORDIRPLUS
))
1068 server
->caps
|= NFS_CAP_READDIRPLUS
;
1070 if (server
->namelen
== 0 || server
->namelen
> NFS2_MAXNAMLEN
)
1071 server
->namelen
= NFS2_MAXNAMLEN
;
1074 if (!(fattr
->valid
& NFS_ATTR_FATTR
)) {
1075 error
= nfs_mod
->rpc_ops
->getattr(server
, mount_info
->mntfh
, fattr
, NULL
);
1077 dprintk("nfs_create_server: getattr error = %d\n", -error
);
1081 memcpy(&server
->fsid
, &fattr
->fsid
, sizeof(server
->fsid
));
1083 dprintk("Server FSID: %llx:%llx\n",
1084 (unsigned long long) server
->fsid
.major
,
1085 (unsigned long long) server
->fsid
.minor
);
1087 nfs_server_insert_lists(server
);
1088 server
->mount_time
= jiffies
;
1089 nfs_free_fattr(fattr
);
1093 nfs_free_fattr(fattr
);
1094 nfs_free_server(server
);
1095 return ERR_PTR(error
);
1097 EXPORT_SYMBOL_GPL(nfs_create_server
);
1100 * Clone an NFS2, NFS3 or NFS4 server record
1102 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
1104 struct nfs_fattr
*fattr
,
1105 rpc_authflavor_t flavor
)
1107 struct nfs_server
*server
;
1108 struct nfs_fattr
*fattr_fsinfo
;
1111 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1112 (unsigned long long) fattr
->fsid
.major
,
1113 (unsigned long long) fattr
->fsid
.minor
);
1115 server
= nfs_alloc_server();
1117 return ERR_PTR(-ENOMEM
);
1120 fattr_fsinfo
= nfs_alloc_fattr();
1121 if (fattr_fsinfo
== NULL
)
1122 goto out_free_server
;
1124 /* Copy data from the source */
1125 server
->nfs_client
= source
->nfs_client
;
1126 server
->destroy
= source
->destroy
;
1127 atomic_inc(&server
->nfs_client
->cl_count
);
1128 nfs_server_copy_userdata(server
, source
);
1130 server
->fsid
= fattr
->fsid
;
1132 error
= nfs_init_server_rpcclient(server
,
1133 source
->client
->cl_timeout
,
1136 goto out_free_server
;
1138 /* probe the filesystem info for this server filesystem */
1139 error
= nfs_probe_fsinfo(server
, fh
, fattr_fsinfo
);
1141 goto out_free_server
;
1143 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1144 server
->namelen
= NFS4_MAXNAMLEN
;
1146 dprintk("Cloned FSID: %llx:%llx\n",
1147 (unsigned long long) server
->fsid
.major
,
1148 (unsigned long long) server
->fsid
.minor
);
1150 error
= nfs_start_lockd(server
);
1152 goto out_free_server
;
1154 nfs_server_insert_lists(server
);
1155 server
->mount_time
= jiffies
;
1157 nfs_free_fattr(fattr_fsinfo
);
1158 dprintk("<-- nfs_clone_server() = %p\n", server
);
1162 nfs_free_fattr(fattr_fsinfo
);
1163 nfs_free_server(server
);
1164 dprintk("<-- nfs_clone_server() = error %d\n", error
);
1165 return ERR_PTR(error
);
1167 EXPORT_SYMBOL_GPL(nfs_clone_server
);
1169 void nfs_clients_init(struct net
*net
)
1171 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1173 INIT_LIST_HEAD(&nn
->nfs_client_list
);
1174 INIT_LIST_HEAD(&nn
->nfs_volume_list
);
1175 #if IS_ENABLED(CONFIG_NFS_V4)
1176 idr_init(&nn
->cb_ident_idr
);
1178 spin_lock_init(&nn
->nfs_client_lock
);
1179 nn
->boot_time
= CURRENT_TIME
;
1182 #ifdef CONFIG_PROC_FS
1183 static struct proc_dir_entry
*proc_fs_nfs
;
1185 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
);
1186 static void *nfs_server_list_start(struct seq_file
*p
, loff_t
*pos
);
1187 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1188 static void nfs_server_list_stop(struct seq_file
*p
, void *v
);
1189 static int nfs_server_list_show(struct seq_file
*m
, void *v
);
1191 static const struct seq_operations nfs_server_list_ops
= {
1192 .start
= nfs_server_list_start
,
1193 .next
= nfs_server_list_next
,
1194 .stop
= nfs_server_list_stop
,
1195 .show
= nfs_server_list_show
,
1198 static const struct file_operations nfs_server_list_fops
= {
1199 .open
= nfs_server_list_open
,
1201 .llseek
= seq_lseek
,
1202 .release
= seq_release
,
1203 .owner
= THIS_MODULE
,
1206 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
);
1207 static void *nfs_volume_list_start(struct seq_file
*p
, loff_t
*pos
);
1208 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1209 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
);
1210 static int nfs_volume_list_show(struct seq_file
*m
, void *v
);
1212 static const struct seq_operations nfs_volume_list_ops
= {
1213 .start
= nfs_volume_list_start
,
1214 .next
= nfs_volume_list_next
,
1215 .stop
= nfs_volume_list_stop
,
1216 .show
= nfs_volume_list_show
,
1219 static const struct file_operations nfs_volume_list_fops
= {
1220 .open
= nfs_volume_list_open
,
1222 .llseek
= seq_lseek
,
1223 .release
= seq_release
,
1224 .owner
= THIS_MODULE
,
1228 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1231 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
)
1235 struct pid_namespace
*pid_ns
= file
->f_dentry
->d_sb
->s_fs_info
;
1236 struct net
*net
= pid_ns
->child_reaper
->nsproxy
->net_ns
;
1238 ret
= seq_open(file
, &nfs_server_list_ops
);
1242 m
= file
->private_data
;
1249 * set up the iterator to start reading from the server list and return the first item
1251 static void *nfs_server_list_start(struct seq_file
*m
, loff_t
*_pos
)
1253 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1255 /* lock the list against modification */
1256 spin_lock(&nn
->nfs_client_lock
);
1257 return seq_list_start_head(&nn
->nfs_client_list
, *_pos
);
1261 * move to next server
1263 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1265 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1267 return seq_list_next(v
, &nn
->nfs_client_list
, pos
);
1271 * clean up after reading from the transports list
1273 static void nfs_server_list_stop(struct seq_file
*p
, void *v
)
1275 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1277 spin_unlock(&nn
->nfs_client_lock
);
1281 * display a header line followed by a load of call lines
1283 static int nfs_server_list_show(struct seq_file
*m
, void *v
)
1285 struct nfs_client
*clp
;
1286 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1288 /* display header on line 1 */
1289 if (v
== &nn
->nfs_client_list
) {
1290 seq_puts(m
, "NV SERVER PORT USE HOSTNAME\n");
1294 /* display one transport per line on subsequent lines */
1295 clp
= list_entry(v
, struct nfs_client
, cl_share_link
);
1297 /* Check if the client is initialized */
1298 if (clp
->cl_cons_state
!= NFS_CS_READY
)
1302 seq_printf(m
, "v%u %s %s %3d %s\n",
1303 clp
->rpc_ops
->version
,
1304 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1305 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1306 atomic_read(&clp
->cl_count
),
1314 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1316 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
)
1320 struct pid_namespace
*pid_ns
= file
->f_dentry
->d_sb
->s_fs_info
;
1321 struct net
*net
= pid_ns
->child_reaper
->nsproxy
->net_ns
;
1323 ret
= seq_open(file
, &nfs_volume_list_ops
);
1327 m
= file
->private_data
;
1334 * set up the iterator to start reading from the volume list and return the first item
1336 static void *nfs_volume_list_start(struct seq_file
*m
, loff_t
*_pos
)
1338 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1340 /* lock the list against modification */
1341 spin_lock(&nn
->nfs_client_lock
);
1342 return seq_list_start_head(&nn
->nfs_volume_list
, *_pos
);
1346 * move to next volume
1348 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1350 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1352 return seq_list_next(v
, &nn
->nfs_volume_list
, pos
);
1356 * clean up after reading from the transports list
1358 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
)
1360 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1362 spin_unlock(&nn
->nfs_client_lock
);
1366 * display a header line followed by a load of call lines
1368 static int nfs_volume_list_show(struct seq_file
*m
, void *v
)
1370 struct nfs_server
*server
;
1371 struct nfs_client
*clp
;
1372 char dev
[8], fsid
[17];
1373 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1375 /* display header on line 1 */
1376 if (v
== &nn
->nfs_volume_list
) {
1377 seq_puts(m
, "NV SERVER PORT DEV FSID FSC\n");
1380 /* display one transport per line on subsequent lines */
1381 server
= list_entry(v
, struct nfs_server
, master_link
);
1382 clp
= server
->nfs_client
;
1384 snprintf(dev
, 8, "%u:%u",
1385 MAJOR(server
->s_dev
), MINOR(server
->s_dev
));
1387 snprintf(fsid
, 17, "%llx:%llx",
1388 (unsigned long long) server
->fsid
.major
,
1389 (unsigned long long) server
->fsid
.minor
);
1392 seq_printf(m
, "v%u %s %s %-7s %-17s %s\n",
1393 clp
->rpc_ops
->version
,
1394 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1395 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1398 nfs_server_fscache_state(server
));
1405 * initialise the /proc/fs/nfsfs/ directory
1407 int __init
nfs_fs_proc_init(void)
1409 struct proc_dir_entry
*p
;
1411 proc_fs_nfs
= proc_mkdir("fs/nfsfs", NULL
);
1415 /* a file of servers with which we're dealing */
1416 p
= proc_create("servers", S_IFREG
|S_IRUGO
,
1417 proc_fs_nfs
, &nfs_server_list_fops
);
1421 /* a file of volumes that we have mounted */
1422 p
= proc_create("volumes", S_IFREG
|S_IRUGO
,
1423 proc_fs_nfs
, &nfs_volume_list_fops
);
1429 remove_proc_entry("servers", proc_fs_nfs
);
1431 remove_proc_entry("fs/nfsfs", NULL
);
1437 * clean up the /proc/fs/nfsfs/ directory
1439 void nfs_fs_proc_exit(void)
1441 remove_proc_entry("volumes", proc_fs_nfs
);
1442 remove_proc_entry("servers", proc_fs_nfs
);
1443 remove_proc_entry("fs/nfsfs", NULL
);
1446 #endif /* CONFIG_PROC_FS */