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 int err
= init_nfs_v2();
160 return init_nfs_v4();
164 * Remove each pre-loaded NFS version
166 void nfs_unregister_versions(void)
174 * Allocate a shared client record
176 * Since these are allocated/deallocated very rarely, we don't
177 * bother putting them in a slab cache...
179 struct nfs_client
*nfs_alloc_client(const struct nfs_client_initdata
*cl_init
)
181 struct nfs_client
*clp
;
182 struct rpc_cred
*cred
;
185 if ((clp
= kzalloc(sizeof(*clp
), GFP_KERNEL
)) == NULL
)
188 clp
->cl_nfs_mod
= cl_init
->nfs_mod
;
189 try_module_get(clp
->cl_nfs_mod
->owner
);
191 clp
->rpc_ops
= clp
->cl_nfs_mod
->rpc_ops
;
193 atomic_set(&clp
->cl_count
, 1);
194 clp
->cl_cons_state
= NFS_CS_INITING
;
196 memcpy(&clp
->cl_addr
, cl_init
->addr
, cl_init
->addrlen
);
197 clp
->cl_addrlen
= cl_init
->addrlen
;
199 if (cl_init
->hostname
) {
201 clp
->cl_hostname
= kstrdup(cl_init
->hostname
, GFP_KERNEL
);
202 if (!clp
->cl_hostname
)
206 INIT_LIST_HEAD(&clp
->cl_superblocks
);
207 clp
->cl_rpcclient
= ERR_PTR(-EINVAL
);
209 clp
->cl_proto
= cl_init
->proto
;
210 clp
->cl_net
= get_net(cl_init
->net
);
212 cred
= rpc_lookup_machine_cred("*");
214 clp
->cl_machine_cred
= cred
;
215 nfs_fscache_get_client_cookie(clp
);
220 put_nfs_version(clp
->cl_nfs_mod
);
227 /* idr_remove_all is not needed as all id's are removed by nfs_put_client */
228 void nfs_cleanup_cb_ident_idr(struct net
*net
)
230 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
232 idr_destroy(&nn
->cb_ident_idr
);
235 /* nfs_client_lock held */
236 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
238 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
240 if (clp
->cl_cb_ident
)
241 idr_remove(&nn
->cb_ident_idr
, clp
->cl_cb_ident
);
244 static void pnfs_init_server(struct nfs_server
*server
)
246 rpc_init_wait_queue(&server
->roc_rpcwaitq
, "pNFS ROC");
250 void nfs_cleanup_cb_ident_idr(struct net
*net
)
254 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
258 static void pnfs_init_server(struct nfs_server
*server
)
262 #endif /* CONFIG_NFS_V4 */
265 * Destroy a shared client record
267 void nfs_free_client(struct nfs_client
*clp
)
269 dprintk("--> nfs_free_client(%u)\n", clp
->rpc_ops
->version
);
271 nfs_fscache_release_client_cookie(clp
);
273 /* -EIO all pending I/O */
274 if (!IS_ERR(clp
->cl_rpcclient
))
275 rpc_shutdown_client(clp
->cl_rpcclient
);
277 if (clp
->cl_machine_cred
!= NULL
)
278 put_rpccred(clp
->cl_machine_cred
);
280 put_net(clp
->cl_net
);
281 put_nfs_version(clp
->cl_nfs_mod
);
282 kfree(clp
->cl_hostname
);
285 dprintk("<-- nfs_free_client()\n");
289 * Release a reference to a shared client record
291 void nfs_put_client(struct nfs_client
*clp
)
298 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp
->cl_count
));
299 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
301 if (atomic_dec_and_lock(&clp
->cl_count
, &nn
->nfs_client_lock
)) {
302 list_del(&clp
->cl_share_link
);
303 nfs_cb_idr_remove_locked(clp
);
304 spin_unlock(&nn
->nfs_client_lock
);
306 BUG_ON(!list_empty(&clp
->cl_superblocks
));
308 clp
->rpc_ops
->free_client(clp
);
311 EXPORT_SYMBOL_GPL(nfs_put_client
);
313 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
315 * Test if two ip6 socket addresses refer to the same socket by
316 * comparing relevant fields. The padding bytes specifically, are not
317 * compared. sin6_flowinfo is not compared because it only affects QoS
318 * and sin6_scope_id is only compared if the address is "link local"
319 * because "link local" addresses need only be unique to a specific
320 * link. Conversely, ordinary unicast addresses might have different
323 * The caller should ensure both socket addresses are AF_INET6.
325 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr
*sa1
,
326 const struct sockaddr
*sa2
)
328 const struct sockaddr_in6
*sin1
= (const struct sockaddr_in6
*)sa1
;
329 const struct sockaddr_in6
*sin2
= (const struct sockaddr_in6
*)sa2
;
331 if (!ipv6_addr_equal(&sin1
->sin6_addr
, &sin2
->sin6_addr
))
333 else if (ipv6_addr_type(&sin1
->sin6_addr
) & IPV6_ADDR_LINKLOCAL
)
334 return sin1
->sin6_scope_id
== sin2
->sin6_scope_id
;
338 #else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
339 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr
*sa1
,
340 const struct sockaddr
*sa2
)
347 * Test if two ip4 socket addresses refer to the same socket, by
348 * comparing relevant fields. The padding bytes specifically, are
351 * The caller should ensure both socket addresses are AF_INET.
353 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr
*sa1
,
354 const struct sockaddr
*sa2
)
356 const struct sockaddr_in
*sin1
= (const struct sockaddr_in
*)sa1
;
357 const struct sockaddr_in
*sin2
= (const struct sockaddr_in
*)sa2
;
359 return sin1
->sin_addr
.s_addr
== sin2
->sin_addr
.s_addr
;
362 static int nfs_sockaddr_cmp_ip6(const struct sockaddr
*sa1
,
363 const struct sockaddr
*sa2
)
365 const struct sockaddr_in6
*sin1
= (const struct sockaddr_in6
*)sa1
;
366 const struct sockaddr_in6
*sin2
= (const struct sockaddr_in6
*)sa2
;
368 return nfs_sockaddr_match_ipaddr6(sa1
, sa2
) &&
369 (sin1
->sin6_port
== sin2
->sin6_port
);
372 static int nfs_sockaddr_cmp_ip4(const struct sockaddr
*sa1
,
373 const struct sockaddr
*sa2
)
375 const struct sockaddr_in
*sin1
= (const struct sockaddr_in
*)sa1
;
376 const struct sockaddr_in
*sin2
= (const struct sockaddr_in
*)sa2
;
378 return nfs_sockaddr_match_ipaddr4(sa1
, sa2
) &&
379 (sin1
->sin_port
== sin2
->sin_port
);
382 #if defined(CONFIG_NFS_V4_1)
384 * Test if two socket addresses represent the same actual socket,
385 * by comparing (only) relevant fields, excluding the port number.
387 int nfs_sockaddr_match_ipaddr(const struct sockaddr
*sa1
,
388 const struct sockaddr
*sa2
)
390 if (sa1
->sa_family
!= sa2
->sa_family
)
393 switch (sa1
->sa_family
) {
395 return nfs_sockaddr_match_ipaddr4(sa1
, sa2
);
397 return nfs_sockaddr_match_ipaddr6(sa1
, sa2
);
401 #endif /* CONFIG_NFS_V4_1 */
404 * Test if two socket addresses represent the same actual socket,
405 * by comparing (only) relevant fields, including the port number.
407 static int nfs_sockaddr_cmp(const struct sockaddr
*sa1
,
408 const struct sockaddr
*sa2
)
410 if (sa1
->sa_family
!= sa2
->sa_family
)
413 switch (sa1
->sa_family
) {
415 return nfs_sockaddr_cmp_ip4(sa1
, sa2
);
417 return nfs_sockaddr_cmp_ip6(sa1
, sa2
);
423 * Find an nfs_client on the list that matches the initialisation data
426 static struct nfs_client
*nfs_match_client(const struct nfs_client_initdata
*data
)
428 struct nfs_client
*clp
;
429 const struct sockaddr
*sap
= data
->addr
;
430 struct nfs_net
*nn
= net_generic(data
->net
, nfs_net_id
);
432 list_for_each_entry(clp
, &nn
->nfs_client_list
, cl_share_link
) {
433 const struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
434 /* Don't match clients that failed to initialise properly */
435 if (clp
->cl_cons_state
< 0)
438 /* Different NFS versions cannot share the same nfs_client */
439 if (clp
->rpc_ops
!= data
->nfs_mod
->rpc_ops
)
442 if (clp
->cl_proto
!= data
->proto
)
444 /* Match nfsv4 minorversion */
445 if (clp
->cl_minorversion
!= data
->minorversion
)
447 /* Match the full socket address */
448 if (!nfs_sockaddr_cmp(sap
, clap
))
451 atomic_inc(&clp
->cl_count
);
457 static bool nfs_client_init_is_complete(const struct nfs_client
*clp
)
459 return clp
->cl_cons_state
!= NFS_CS_INITING
;
462 int nfs_wait_client_init_complete(const struct nfs_client
*clp
)
464 return wait_event_killable(nfs_client_active_wq
,
465 nfs_client_init_is_complete(clp
));
469 * Found an existing client. Make sure it's ready before returning.
471 static struct nfs_client
*
472 nfs_found_client(const struct nfs_client_initdata
*cl_init
,
473 struct nfs_client
*clp
)
477 error
= nfs_wait_client_init_complete(clp
);
480 return ERR_PTR(-ERESTARTSYS
);
483 if (clp
->cl_cons_state
< NFS_CS_READY
) {
484 error
= clp
->cl_cons_state
;
486 return ERR_PTR(error
);
491 dprintk("<-- %s found nfs_client %p for %s\n",
492 __func__
, clp
, cl_init
->hostname
?: "");
497 * Look up a client by IP address and protocol version
498 * - creates a new record if one doesn't yet exist
501 nfs_get_client(const struct nfs_client_initdata
*cl_init
,
502 const struct rpc_timeout
*timeparms
,
504 rpc_authflavor_t authflavour
)
506 struct nfs_client
*clp
, *new = NULL
;
507 struct nfs_net
*nn
= net_generic(cl_init
->net
, nfs_net_id
);
508 const struct nfs_rpc_ops
*rpc_ops
= cl_init
->nfs_mod
->rpc_ops
;
510 dprintk("--> nfs_get_client(%s,v%u)\n",
511 cl_init
->hostname
?: "", rpc_ops
->version
);
513 /* see if the client already exists */
515 spin_lock(&nn
->nfs_client_lock
);
517 clp
= nfs_match_client(cl_init
);
519 spin_unlock(&nn
->nfs_client_lock
);
521 new->rpc_ops
->free_client(new);
522 return nfs_found_client(cl_init
, clp
);
525 list_add(&new->cl_share_link
, &nn
->nfs_client_list
);
526 spin_unlock(&nn
->nfs_client_lock
);
527 new->cl_flags
= cl_init
->init_flags
;
528 return rpc_ops
->init_client(new, timeparms
, ip_addr
,
532 spin_unlock(&nn
->nfs_client_lock
);
534 new = rpc_ops
->alloc_client(cl_init
);
535 } while (!IS_ERR(new));
537 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
538 cl_init
->hostname
?: "", PTR_ERR(new));
543 * Mark a server as ready or failed
545 void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
548 clp
->cl_cons_state
= state
;
549 wake_up_all(&nfs_client_active_wq
);
553 * Initialise the timeout values for a connection
555 void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
556 unsigned int timeo
, unsigned int retrans
)
558 to
->to_initval
= timeo
* HZ
/ 10;
559 to
->to_retries
= retrans
;
562 case XPRT_TRANSPORT_TCP
:
563 case XPRT_TRANSPORT_RDMA
:
564 if (to
->to_retries
== 0)
565 to
->to_retries
= NFS_DEF_TCP_RETRANS
;
566 if (to
->to_initval
== 0)
567 to
->to_initval
= NFS_DEF_TCP_TIMEO
* HZ
/ 10;
568 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
569 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
570 to
->to_increment
= to
->to_initval
;
571 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
572 if (to
->to_maxval
> NFS_MAX_TCP_TIMEOUT
)
573 to
->to_maxval
= NFS_MAX_TCP_TIMEOUT
;
574 if (to
->to_maxval
< to
->to_initval
)
575 to
->to_maxval
= to
->to_initval
;
576 to
->to_exponential
= 0;
578 case XPRT_TRANSPORT_UDP
:
579 if (to
->to_retries
== 0)
580 to
->to_retries
= NFS_DEF_UDP_RETRANS
;
582 to
->to_initval
= NFS_DEF_UDP_TIMEO
* HZ
/ 10;
583 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
584 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
585 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
586 to
->to_exponential
= 1;
594 * Create an RPC client handle
596 int nfs_create_rpc_client(struct nfs_client
*clp
,
597 const struct rpc_timeout
*timeparms
,
598 rpc_authflavor_t flavor
)
600 struct rpc_clnt
*clnt
= NULL
;
601 struct rpc_create_args args
= {
603 .protocol
= clp
->cl_proto
,
604 .address
= (struct sockaddr
*)&clp
->cl_addr
,
605 .addrsize
= clp
->cl_addrlen
,
606 .timeout
= timeparms
,
607 .servername
= clp
->cl_hostname
,
608 .program
= &nfs_program
,
609 .version
= clp
->rpc_ops
->version
,
610 .authflavor
= flavor
,
613 if (test_bit(NFS_CS_DISCRTRY
, &clp
->cl_flags
))
614 args
.flags
|= RPC_CLNT_CREATE_DISCRTRY
;
615 if (test_bit(NFS_CS_NORESVPORT
, &clp
->cl_flags
))
616 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
618 if (!IS_ERR(clp
->cl_rpcclient
))
621 clnt
= rpc_create(&args
);
623 dprintk("%s: cannot create RPC client. Error = %ld\n",
624 __func__
, PTR_ERR(clnt
));
625 return PTR_ERR(clnt
);
628 clp
->cl_rpcclient
= clnt
;
633 * Version 2 or 3 client destruction
635 static void nfs_destroy_server(struct nfs_server
*server
)
637 if (!(server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) ||
638 !(server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
639 nlmclnt_done(server
->nlm_host
);
643 * Version 2 or 3 lockd setup
645 static int nfs_start_lockd(struct nfs_server
*server
)
647 struct nlm_host
*host
;
648 struct nfs_client
*clp
= server
->nfs_client
;
649 struct nlmclnt_initdata nlm_init
= {
650 .hostname
= clp
->cl_hostname
,
651 .address
= (struct sockaddr
*)&clp
->cl_addr
,
652 .addrlen
= clp
->cl_addrlen
,
653 .nfs_version
= clp
->rpc_ops
->version
,
654 .noresvport
= server
->flags
& NFS_MOUNT_NORESVPORT
?
659 if (nlm_init
.nfs_version
> 3)
661 if ((server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) &&
662 (server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
665 switch (clp
->cl_proto
) {
667 nlm_init
.protocol
= IPPROTO_TCP
;
669 case XPRT_TRANSPORT_UDP
:
670 nlm_init
.protocol
= IPPROTO_UDP
;
673 host
= nlmclnt_init(&nlm_init
);
675 return PTR_ERR(host
);
677 server
->nlm_host
= host
;
678 server
->destroy
= nfs_destroy_server
;
683 * Create a general RPC client
685 int nfs_init_server_rpcclient(struct nfs_server
*server
,
686 const struct rpc_timeout
*timeo
,
687 rpc_authflavor_t pseudoflavour
)
689 struct nfs_client
*clp
= server
->nfs_client
;
691 server
->client
= rpc_clone_client(clp
->cl_rpcclient
);
692 if (IS_ERR(server
->client
)) {
693 dprintk("%s: couldn't create rpc_client!\n", __func__
);
694 return PTR_ERR(server
->client
);
697 memcpy(&server
->client
->cl_timeout_default
,
699 sizeof(server
->client
->cl_timeout_default
));
700 server
->client
->cl_timeout
= &server
->client
->cl_timeout_default
;
702 if (pseudoflavour
!= clp
->cl_rpcclient
->cl_auth
->au_flavor
) {
703 struct rpc_auth
*auth
;
705 auth
= rpcauth_create(pseudoflavour
, server
->client
);
707 dprintk("%s: couldn't create credcache!\n", __func__
);
708 return PTR_ERR(auth
);
711 server
->client
->cl_softrtry
= 0;
712 if (server
->flags
& NFS_MOUNT_SOFT
)
713 server
->client
->cl_softrtry
= 1;
719 * nfs_init_client - Initialise an NFS2 or NFS3 client
721 * @clp: nfs_client to initialise
722 * @timeparms: timeout parameters for underlying RPC transport
723 * @ip_addr: IP presentation address (not used)
724 * @authflavor: authentication flavor for underlying RPC transport
726 * Returns pointer to an NFS client, or an ERR_PTR value.
728 struct nfs_client
*nfs_init_client(struct nfs_client
*clp
,
729 const struct rpc_timeout
*timeparms
,
730 const char *ip_addr
, rpc_authflavor_t authflavour
)
734 if (clp
->cl_cons_state
== NFS_CS_READY
) {
735 /* the client is already initialised */
736 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp
);
741 * Create a client RPC handle for doing FSSTAT with UNIX auth only
742 * - RFC 2623, sec 2.3.2
744 error
= nfs_create_rpc_client(clp
, timeparms
, RPC_AUTH_UNIX
);
747 nfs_mark_client_ready(clp
, NFS_CS_READY
);
751 nfs_mark_client_ready(clp
, error
);
753 dprintk("<-- nfs_init_client() = xerror %d\n", error
);
754 return ERR_PTR(error
);
758 * Create a version 2 or 3 client
760 static int nfs_init_server(struct nfs_server
*server
,
761 const struct nfs_parsed_mount_data
*data
,
762 struct nfs_subversion
*nfs_mod
)
764 struct nfs_client_initdata cl_init
= {
765 .hostname
= data
->nfs_server
.hostname
,
766 .addr
= (const struct sockaddr
*)&data
->nfs_server
.address
,
767 .addrlen
= data
->nfs_server
.addrlen
,
769 .proto
= data
->nfs_server
.protocol
,
772 struct rpc_timeout timeparms
;
773 struct nfs_client
*clp
;
776 dprintk("--> nfs_init_server()\n");
778 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
779 data
->timeo
, data
->retrans
);
780 if (data
->flags
& NFS_MOUNT_NORESVPORT
)
781 set_bit(NFS_CS_NORESVPORT
, &cl_init
.init_flags
);
783 /* Allocate or find a client reference we can use */
784 clp
= nfs_get_client(&cl_init
, &timeparms
, NULL
, RPC_AUTH_UNIX
);
786 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp
));
790 server
->nfs_client
= clp
;
792 /* Initialise the client representation from the mount data */
793 server
->flags
= data
->flags
;
794 server
->options
= data
->options
;
795 server
->caps
|= NFS_CAP_HARDLINKS
|NFS_CAP_SYMLINKS
|NFS_CAP_FILEID
|
796 NFS_CAP_MODE
|NFS_CAP_NLINK
|NFS_CAP_OWNER
|NFS_CAP_OWNER_GROUP
|
797 NFS_CAP_ATIME
|NFS_CAP_CTIME
|NFS_CAP_MTIME
|NFS_CAP_CHANGE_ATTR
;
800 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
802 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
804 server
->acregmin
= data
->acregmin
* HZ
;
805 server
->acregmax
= data
->acregmax
* HZ
;
806 server
->acdirmin
= data
->acdirmin
* HZ
;
807 server
->acdirmax
= data
->acdirmax
* HZ
;
809 /* Start lockd here, before we might error out */
810 error
= nfs_start_lockd(server
);
814 server
->port
= data
->nfs_server
.port
;
816 error
= nfs_init_server_rpcclient(server
, &timeparms
, data
->auth_flavors
[0]);
820 /* Preserve the values of mount_server-related mount options */
821 if (data
->mount_server
.addrlen
) {
822 memcpy(&server
->mountd_address
, &data
->mount_server
.address
,
823 data
->mount_server
.addrlen
);
824 server
->mountd_addrlen
= data
->mount_server
.addrlen
;
826 server
->mountd_version
= data
->mount_server
.version
;
827 server
->mountd_port
= data
->mount_server
.port
;
828 server
->mountd_protocol
= data
->mount_server
.protocol
;
830 server
->namelen
= data
->namlen
;
831 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp
);
835 server
->nfs_client
= NULL
;
837 dprintk("<-- nfs_init_server() = xerror %d\n", error
);
842 * Load up the server record from information gained in an fsinfo record
844 static void nfs_server_set_fsinfo(struct nfs_server
*server
,
845 struct nfs_fh
*mntfh
,
846 struct nfs_fsinfo
*fsinfo
)
848 unsigned long max_rpc_payload
;
850 /* Work out a lot of parameters */
851 if (server
->rsize
== 0)
852 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
853 if (server
->wsize
== 0)
854 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
856 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
857 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
858 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
859 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
861 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
862 if (server
->rsize
> max_rpc_payload
)
863 server
->rsize
= max_rpc_payload
;
864 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
865 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
866 server
->rpages
= (server
->rsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
868 server
->backing_dev_info
.name
= "nfs";
869 server
->backing_dev_info
.ra_pages
= server
->rpages
* NFS_MAX_READAHEAD
;
871 if (server
->wsize
> max_rpc_payload
)
872 server
->wsize
= max_rpc_payload
;
873 if (server
->wsize
> NFS_MAX_FILE_IO_SIZE
)
874 server
->wsize
= NFS_MAX_FILE_IO_SIZE
;
875 server
->wpages
= (server
->wsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
876 server
->pnfs_blksize
= fsinfo
->blksize
;
878 server
->wtmult
= nfs_block_bits(fsinfo
->wtmult
, NULL
);
880 server
->dtsize
= nfs_block_size(fsinfo
->dtpref
, NULL
);
881 if (server
->dtsize
> PAGE_CACHE_SIZE
* NFS_MAX_READDIR_PAGES
)
882 server
->dtsize
= PAGE_CACHE_SIZE
* NFS_MAX_READDIR_PAGES
;
883 if (server
->dtsize
> server
->rsize
)
884 server
->dtsize
= server
->rsize
;
886 if (server
->flags
& NFS_MOUNT_NOAC
) {
887 server
->acregmin
= server
->acregmax
= 0;
888 server
->acdirmin
= server
->acdirmax
= 0;
891 server
->maxfilesize
= fsinfo
->maxfilesize
;
893 server
->time_delta
= fsinfo
->time_delta
;
895 /* We're airborne Set socket buffersize */
896 rpc_setbufsize(server
->client
, server
->wsize
+ 100, server
->rsize
+ 100);
900 * Probe filesystem information, including the FSID on v2/v3
902 int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*mntfh
, struct nfs_fattr
*fattr
)
904 struct nfs_fsinfo fsinfo
;
905 struct nfs_client
*clp
= server
->nfs_client
;
908 dprintk("--> nfs_probe_fsinfo()\n");
910 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
911 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
916 fsinfo
.fattr
= fattr
;
917 fsinfo
.layouttype
= 0;
918 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
922 nfs_server_set_fsinfo(server
, mntfh
, &fsinfo
);
924 /* Get some general file system info */
925 if (server
->namelen
== 0) {
926 struct nfs_pathconf pathinfo
;
928 pathinfo
.fattr
= fattr
;
929 nfs_fattr_init(fattr
);
931 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
932 server
->namelen
= pathinfo
.max_namelen
;
935 dprintk("<-- nfs_probe_fsinfo() = 0\n");
939 dprintk("nfs_probe_fsinfo: error = %d\n", -error
);
944 * Copy useful information when duplicating a server record
946 void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
948 target
->flags
= source
->flags
;
949 target
->rsize
= source
->rsize
;
950 target
->wsize
= source
->wsize
;
951 target
->acregmin
= source
->acregmin
;
952 target
->acregmax
= source
->acregmax
;
953 target
->acdirmin
= source
->acdirmin
;
954 target
->acdirmax
= source
->acdirmax
;
955 target
->caps
= source
->caps
;
956 target
->options
= source
->options
;
959 void nfs_server_insert_lists(struct nfs_server
*server
)
961 struct nfs_client
*clp
= server
->nfs_client
;
962 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
964 spin_lock(&nn
->nfs_client_lock
);
965 list_add_tail_rcu(&server
->client_link
, &clp
->cl_superblocks
);
966 list_add_tail(&server
->master_link
, &nn
->nfs_volume_list
);
967 clear_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
968 spin_unlock(&nn
->nfs_client_lock
);
972 static void nfs_server_remove_lists(struct nfs_server
*server
)
974 struct nfs_client
*clp
= server
->nfs_client
;
979 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
980 spin_lock(&nn
->nfs_client_lock
);
981 list_del_rcu(&server
->client_link
);
982 if (list_empty(&clp
->cl_superblocks
))
983 set_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
984 list_del(&server
->master_link
);
985 spin_unlock(&nn
->nfs_client_lock
);
991 * Allocate and initialise a server record
993 struct nfs_server
*nfs_alloc_server(void)
995 struct nfs_server
*server
;
997 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
1001 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
1003 /* Zero out the NFS state stuff */
1004 INIT_LIST_HEAD(&server
->client_link
);
1005 INIT_LIST_HEAD(&server
->master_link
);
1006 INIT_LIST_HEAD(&server
->delegations
);
1007 INIT_LIST_HEAD(&server
->layouts
);
1008 INIT_LIST_HEAD(&server
->state_owners_lru
);
1010 atomic_set(&server
->active
, 0);
1012 server
->io_stats
= nfs_alloc_iostats();
1013 if (!server
->io_stats
) {
1018 if (bdi_init(&server
->backing_dev_info
)) {
1019 nfs_free_iostats(server
->io_stats
);
1024 ida_init(&server
->openowner_id
);
1025 ida_init(&server
->lockowner_id
);
1026 pnfs_init_server(server
);
1032 * Free up a server record
1034 void nfs_free_server(struct nfs_server
*server
)
1036 dprintk("--> nfs_free_server()\n");
1038 nfs_server_remove_lists(server
);
1040 if (server
->destroy
!= NULL
)
1041 server
->destroy(server
);
1043 if (!IS_ERR(server
->client_acl
))
1044 rpc_shutdown_client(server
->client_acl
);
1045 if (!IS_ERR(server
->client
))
1046 rpc_shutdown_client(server
->client
);
1048 nfs_put_client(server
->nfs_client
);
1050 ida_destroy(&server
->lockowner_id
);
1051 ida_destroy(&server
->openowner_id
);
1052 nfs_free_iostats(server
->io_stats
);
1053 bdi_destroy(&server
->backing_dev_info
);
1055 nfs_release_automount_timer();
1056 dprintk("<-- nfs_free_server()\n");
1060 * Create a version 2 or 3 volume record
1061 * - keyed on server and FSID
1063 struct nfs_server
*nfs_create_server(struct nfs_mount_info
*mount_info
,
1064 struct nfs_subversion
*nfs_mod
)
1066 struct nfs_server
*server
;
1067 struct nfs_fattr
*fattr
;
1070 server
= nfs_alloc_server();
1072 return ERR_PTR(-ENOMEM
);
1075 fattr
= nfs_alloc_fattr();
1079 /* Get a client representation */
1080 error
= nfs_init_server(server
, mount_info
->parsed
, nfs_mod
);
1084 BUG_ON(!server
->nfs_client
);
1085 BUG_ON(!server
->nfs_client
->rpc_ops
);
1086 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1088 /* Probe the root fh to retrieve its FSID */
1089 error
= nfs_probe_fsinfo(server
, mount_info
->mntfh
, fattr
);
1092 if (server
->nfs_client
->rpc_ops
->version
== 3) {
1093 if (server
->namelen
== 0 || server
->namelen
> NFS3_MAXNAMLEN
)
1094 server
->namelen
= NFS3_MAXNAMLEN
;
1095 if (!(mount_info
->parsed
->flags
& NFS_MOUNT_NORDIRPLUS
))
1096 server
->caps
|= NFS_CAP_READDIRPLUS
;
1098 if (server
->namelen
== 0 || server
->namelen
> NFS2_MAXNAMLEN
)
1099 server
->namelen
= NFS2_MAXNAMLEN
;
1102 if (!(fattr
->valid
& NFS_ATTR_FATTR
)) {
1103 error
= nfs_mod
->rpc_ops
->getattr(server
, mount_info
->mntfh
, fattr
);
1105 dprintk("nfs_create_server: getattr error = %d\n", -error
);
1109 memcpy(&server
->fsid
, &fattr
->fsid
, sizeof(server
->fsid
));
1111 dprintk("Server FSID: %llx:%llx\n",
1112 (unsigned long long) server
->fsid
.major
,
1113 (unsigned long long) server
->fsid
.minor
);
1115 nfs_server_insert_lists(server
);
1116 server
->mount_time
= jiffies
;
1117 nfs_free_fattr(fattr
);
1121 nfs_free_fattr(fattr
);
1122 nfs_free_server(server
);
1123 return ERR_PTR(error
);
1127 * Clone an NFS2, NFS3 or NFS4 server record
1129 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
1131 struct nfs_fattr
*fattr
,
1132 rpc_authflavor_t flavor
)
1134 struct nfs_server
*server
;
1135 struct nfs_fattr
*fattr_fsinfo
;
1138 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1139 (unsigned long long) fattr
->fsid
.major
,
1140 (unsigned long long) fattr
->fsid
.minor
);
1142 server
= nfs_alloc_server();
1144 return ERR_PTR(-ENOMEM
);
1147 fattr_fsinfo
= nfs_alloc_fattr();
1148 if (fattr_fsinfo
== NULL
)
1149 goto out_free_server
;
1151 /* Copy data from the source */
1152 server
->nfs_client
= source
->nfs_client
;
1153 server
->destroy
= source
->destroy
;
1154 atomic_inc(&server
->nfs_client
->cl_count
);
1155 nfs_server_copy_userdata(server
, source
);
1157 server
->fsid
= fattr
->fsid
;
1159 error
= nfs_init_server_rpcclient(server
,
1160 source
->client
->cl_timeout
,
1163 goto out_free_server
;
1165 /* probe the filesystem info for this server filesystem */
1166 error
= nfs_probe_fsinfo(server
, fh
, fattr_fsinfo
);
1168 goto out_free_server
;
1170 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1171 server
->namelen
= NFS4_MAXNAMLEN
;
1173 dprintk("Cloned FSID: %llx:%llx\n",
1174 (unsigned long long) server
->fsid
.major
,
1175 (unsigned long long) server
->fsid
.minor
);
1177 error
= nfs_start_lockd(server
);
1179 goto out_free_server
;
1181 nfs_server_insert_lists(server
);
1182 server
->mount_time
= jiffies
;
1184 nfs_free_fattr(fattr_fsinfo
);
1185 dprintk("<-- nfs_clone_server() = %p\n", server
);
1189 nfs_free_fattr(fattr_fsinfo
);
1190 nfs_free_server(server
);
1191 dprintk("<-- nfs_clone_server() = error %d\n", error
);
1192 return ERR_PTR(error
);
1195 void nfs_clients_init(struct net
*net
)
1197 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
1199 INIT_LIST_HEAD(&nn
->nfs_client_list
);
1200 INIT_LIST_HEAD(&nn
->nfs_volume_list
);
1201 #ifdef CONFIG_NFS_V4
1202 idr_init(&nn
->cb_ident_idr
);
1204 spin_lock_init(&nn
->nfs_client_lock
);
1205 nn
->boot_time
= CURRENT_TIME
;
1208 #ifdef CONFIG_PROC_FS
1209 static struct proc_dir_entry
*proc_fs_nfs
;
1211 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
);
1212 static void *nfs_server_list_start(struct seq_file
*p
, loff_t
*pos
);
1213 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1214 static void nfs_server_list_stop(struct seq_file
*p
, void *v
);
1215 static int nfs_server_list_show(struct seq_file
*m
, void *v
);
1217 static const struct seq_operations nfs_server_list_ops
= {
1218 .start
= nfs_server_list_start
,
1219 .next
= nfs_server_list_next
,
1220 .stop
= nfs_server_list_stop
,
1221 .show
= nfs_server_list_show
,
1224 static const struct file_operations nfs_server_list_fops
= {
1225 .open
= nfs_server_list_open
,
1227 .llseek
= seq_lseek
,
1228 .release
= seq_release
,
1229 .owner
= THIS_MODULE
,
1232 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
);
1233 static void *nfs_volume_list_start(struct seq_file
*p
, loff_t
*pos
);
1234 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1235 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
);
1236 static int nfs_volume_list_show(struct seq_file
*m
, void *v
);
1238 static const struct seq_operations nfs_volume_list_ops
= {
1239 .start
= nfs_volume_list_start
,
1240 .next
= nfs_volume_list_next
,
1241 .stop
= nfs_volume_list_stop
,
1242 .show
= nfs_volume_list_show
,
1245 static const struct file_operations nfs_volume_list_fops
= {
1246 .open
= nfs_volume_list_open
,
1248 .llseek
= seq_lseek
,
1249 .release
= seq_release
,
1250 .owner
= THIS_MODULE
,
1254 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1257 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
)
1261 struct pid_namespace
*pid_ns
= file
->f_dentry
->d_sb
->s_fs_info
;
1262 struct net
*net
= pid_ns
->child_reaper
->nsproxy
->net_ns
;
1264 ret
= seq_open(file
, &nfs_server_list_ops
);
1268 m
= file
->private_data
;
1275 * set up the iterator to start reading from the server list and return the first item
1277 static void *nfs_server_list_start(struct seq_file
*m
, loff_t
*_pos
)
1279 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1281 /* lock the list against modification */
1282 spin_lock(&nn
->nfs_client_lock
);
1283 return seq_list_start_head(&nn
->nfs_client_list
, *_pos
);
1287 * move to next server
1289 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1291 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1293 return seq_list_next(v
, &nn
->nfs_client_list
, pos
);
1297 * clean up after reading from the transports list
1299 static void nfs_server_list_stop(struct seq_file
*p
, void *v
)
1301 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1303 spin_unlock(&nn
->nfs_client_lock
);
1307 * display a header line followed by a load of call lines
1309 static int nfs_server_list_show(struct seq_file
*m
, void *v
)
1311 struct nfs_client
*clp
;
1312 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1314 /* display header on line 1 */
1315 if (v
== &nn
->nfs_client_list
) {
1316 seq_puts(m
, "NV SERVER PORT USE HOSTNAME\n");
1320 /* display one transport per line on subsequent lines */
1321 clp
= list_entry(v
, struct nfs_client
, cl_share_link
);
1323 /* Check if the client is initialized */
1324 if (clp
->cl_cons_state
!= NFS_CS_READY
)
1328 seq_printf(m
, "v%u %s %s %3d %s\n",
1329 clp
->rpc_ops
->version
,
1330 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1331 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1332 atomic_read(&clp
->cl_count
),
1340 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1342 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
)
1346 struct pid_namespace
*pid_ns
= file
->f_dentry
->d_sb
->s_fs_info
;
1347 struct net
*net
= pid_ns
->child_reaper
->nsproxy
->net_ns
;
1349 ret
= seq_open(file
, &nfs_volume_list_ops
);
1353 m
= file
->private_data
;
1360 * set up the iterator to start reading from the volume list and return the first item
1362 static void *nfs_volume_list_start(struct seq_file
*m
, loff_t
*_pos
)
1364 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1366 /* lock the list against modification */
1367 spin_lock(&nn
->nfs_client_lock
);
1368 return seq_list_start_head(&nn
->nfs_volume_list
, *_pos
);
1372 * move to next volume
1374 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1376 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1378 return seq_list_next(v
, &nn
->nfs_volume_list
, pos
);
1382 * clean up after reading from the transports list
1384 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
)
1386 struct nfs_net
*nn
= net_generic(p
->private, nfs_net_id
);
1388 spin_unlock(&nn
->nfs_client_lock
);
1392 * display a header line followed by a load of call lines
1394 static int nfs_volume_list_show(struct seq_file
*m
, void *v
)
1396 struct nfs_server
*server
;
1397 struct nfs_client
*clp
;
1398 char dev
[8], fsid
[17];
1399 struct nfs_net
*nn
= net_generic(m
->private, nfs_net_id
);
1401 /* display header on line 1 */
1402 if (v
== &nn
->nfs_volume_list
) {
1403 seq_puts(m
, "NV SERVER PORT DEV FSID FSC\n");
1406 /* display one transport per line on subsequent lines */
1407 server
= list_entry(v
, struct nfs_server
, master_link
);
1408 clp
= server
->nfs_client
;
1410 snprintf(dev
, 8, "%u:%u",
1411 MAJOR(server
->s_dev
), MINOR(server
->s_dev
));
1413 snprintf(fsid
, 17, "%llx:%llx",
1414 (unsigned long long) server
->fsid
.major
,
1415 (unsigned long long) server
->fsid
.minor
);
1418 seq_printf(m
, "v%u %s %s %-7s %-17s %s\n",
1419 clp
->rpc_ops
->version
,
1420 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1421 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1424 nfs_server_fscache_state(server
));
1431 * initialise the /proc/fs/nfsfs/ directory
1433 int __init
nfs_fs_proc_init(void)
1435 struct proc_dir_entry
*p
;
1437 proc_fs_nfs
= proc_mkdir("fs/nfsfs", NULL
);
1441 /* a file of servers with which we're dealing */
1442 p
= proc_create("servers", S_IFREG
|S_IRUGO
,
1443 proc_fs_nfs
, &nfs_server_list_fops
);
1447 /* a file of volumes that we have mounted */
1448 p
= proc_create("volumes", S_IFREG
|S_IRUGO
,
1449 proc_fs_nfs
, &nfs_volume_list_fops
);
1455 remove_proc_entry("servers", proc_fs_nfs
);
1457 remove_proc_entry("fs/nfsfs", NULL
);
1463 * clean up the /proc/fs/nfsfs/ directory
1465 void nfs_fs_proc_exit(void)
1467 remove_proc_entry("volumes", proc_fs_nfs
);
1468 remove_proc_entry("servers", proc_fs_nfs
);
1469 remove_proc_entry("fs/nfsfs", NULL
);
1472 #endif /* CONFIG_PROC_FS */