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_v3();
156 return init_nfs_v4();
160 * Remove each pre-loaded NFS version
162 void nfs_unregister_versions(void)
169 * Allocate a shared client record
171 * Since these are allocated/deallocated very rarely, we don't
172 * bother putting them in a slab cache...
174 struct nfs_client
*nfs_alloc_client(const struct nfs_client_initdata
*cl_init
)
176 struct nfs_client
*clp
;
177 struct rpc_cred
*cred
;
180 if ((clp
= kzalloc(sizeof(*clp
), GFP_KERNEL
)) == NULL
)
183 clp
->cl_nfs_mod
= cl_init
->nfs_mod
;
184 try_module_get(clp
->cl_nfs_mod
->owner
);
186 clp
->rpc_ops
= clp
->cl_nfs_mod
->rpc_ops
;
188 atomic_set(&clp
->cl_count
, 1);
189 clp
->cl_cons_state
= NFS_CS_INITING
;
191 memcpy(&clp
->cl_addr
, cl_init
->addr
, cl_init
->addrlen
);
192 clp
->cl_addrlen
= cl_init
->addrlen
;
194 if (cl_init
->hostname
) {
196 clp
->cl_hostname
= kstrdup(cl_init
->hostname
, GFP_KERNEL
);
197 if (!clp
->cl_hostname
)
201 INIT_LIST_HEAD(&clp
->cl_superblocks
);
202 clp
->cl_rpcclient
= ERR_PTR(-EINVAL
);
204 clp
->cl_proto
= cl_init
->proto
;
205 clp
->cl_net
= get_net(cl_init
->net
);
207 cred
= rpc_lookup_machine_cred("*");
209 clp
->cl_machine_cred
= cred
;
210 nfs_fscache_get_client_cookie(clp
);
215 put_nfs_version(clp
->cl_nfs_mod
);
220 EXPORT_SYMBOL_GPL(nfs_alloc_client
);
223 /* idr_remove_all is not needed as all id's are removed by nfs_put_client */
224 void nfs_cleanup_cb_ident_idr(struct net
*net
)
226 struct nfs_net
*nn
= net_generic(net
, nfs_net_id
);
228 idr_destroy(&nn
->cb_ident_idr
);
231 /* nfs_client_lock held */
232 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
234 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
236 if (clp
->cl_cb_ident
)
237 idr_remove(&nn
->cb_ident_idr
, clp
->cl_cb_ident
);
240 static void pnfs_init_server(struct nfs_server
*server
)
242 rpc_init_wait_queue(&server
->roc_rpcwaitq
, "pNFS ROC");
246 void nfs_cleanup_cb_ident_idr(struct net
*net
)
250 static void nfs_cb_idr_remove_locked(struct nfs_client
*clp
)
254 static void pnfs_init_server(struct nfs_server
*server
)
258 #endif /* CONFIG_NFS_V4 */
261 * Destroy a shared client record
263 void nfs_free_client(struct nfs_client
*clp
)
265 dprintk("--> nfs_free_client(%u)\n", clp
->rpc_ops
->version
);
267 nfs_fscache_release_client_cookie(clp
);
269 /* -EIO all pending I/O */
270 if (!IS_ERR(clp
->cl_rpcclient
))
271 rpc_shutdown_client(clp
->cl_rpcclient
);
273 if (clp
->cl_machine_cred
!= NULL
)
274 put_rpccred(clp
->cl_machine_cred
);
276 put_net(clp
->cl_net
);
277 put_nfs_version(clp
->cl_nfs_mod
);
278 kfree(clp
->cl_hostname
);
281 dprintk("<-- nfs_free_client()\n");
283 EXPORT_SYMBOL_GPL(nfs_free_client
);
286 * Release a reference to a shared client record
288 void nfs_put_client(struct nfs_client
*clp
)
295 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp
->cl_count
));
296 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
298 if (atomic_dec_and_lock(&clp
->cl_count
, &nn
->nfs_client_lock
)) {
299 list_del(&clp
->cl_share_link
);
300 nfs_cb_idr_remove_locked(clp
);
301 spin_unlock(&nn
->nfs_client_lock
);
303 BUG_ON(!list_empty(&clp
->cl_superblocks
));
305 clp
->rpc_ops
->free_client(clp
);
308 EXPORT_SYMBOL_GPL(nfs_put_client
);
310 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
312 * Test if two ip6 socket addresses refer to the same socket by
313 * comparing relevant fields. The padding bytes specifically, are not
314 * compared. sin6_flowinfo is not compared because it only affects QoS
315 * and sin6_scope_id is only compared if the address is "link local"
316 * because "link local" addresses need only be unique to a specific
317 * link. Conversely, ordinary unicast addresses might have different
320 * The caller should ensure both socket addresses are AF_INET6.
322 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr
*sa1
,
323 const struct sockaddr
*sa2
)
325 const struct sockaddr_in6
*sin1
= (const struct sockaddr_in6
*)sa1
;
326 const struct sockaddr_in6
*sin2
= (const struct sockaddr_in6
*)sa2
;
328 if (!ipv6_addr_equal(&sin1
->sin6_addr
, &sin2
->sin6_addr
))
330 else if (ipv6_addr_type(&sin1
->sin6_addr
) & IPV6_ADDR_LINKLOCAL
)
331 return sin1
->sin6_scope_id
== sin2
->sin6_scope_id
;
335 #else /* !defined(CONFIG_IPV6) && !defined(CONFIG_IPV6_MODULE) */
336 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr
*sa1
,
337 const struct sockaddr
*sa2
)
344 * Test if two ip4 socket addresses refer to the same socket, by
345 * comparing relevant fields. The padding bytes specifically, are
348 * The caller should ensure both socket addresses are AF_INET.
350 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr
*sa1
,
351 const struct sockaddr
*sa2
)
353 const struct sockaddr_in
*sin1
= (const struct sockaddr_in
*)sa1
;
354 const struct sockaddr_in
*sin2
= (const struct sockaddr_in
*)sa2
;
356 return sin1
->sin_addr
.s_addr
== sin2
->sin_addr
.s_addr
;
359 static int nfs_sockaddr_cmp_ip6(const struct sockaddr
*sa1
,
360 const struct sockaddr
*sa2
)
362 const struct sockaddr_in6
*sin1
= (const struct sockaddr_in6
*)sa1
;
363 const struct sockaddr_in6
*sin2
= (const struct sockaddr_in6
*)sa2
;
365 return nfs_sockaddr_match_ipaddr6(sa1
, sa2
) &&
366 (sin1
->sin6_port
== sin2
->sin6_port
);
369 static int nfs_sockaddr_cmp_ip4(const struct sockaddr
*sa1
,
370 const struct sockaddr
*sa2
)
372 const struct sockaddr_in
*sin1
= (const struct sockaddr_in
*)sa1
;
373 const struct sockaddr_in
*sin2
= (const struct sockaddr_in
*)sa2
;
375 return nfs_sockaddr_match_ipaddr4(sa1
, sa2
) &&
376 (sin1
->sin_port
== sin2
->sin_port
);
379 #if defined(CONFIG_NFS_V4_1)
381 * Test if two socket addresses represent the same actual socket,
382 * by comparing (only) relevant fields, excluding the port number.
384 int nfs_sockaddr_match_ipaddr(const struct sockaddr
*sa1
,
385 const struct sockaddr
*sa2
)
387 if (sa1
->sa_family
!= sa2
->sa_family
)
390 switch (sa1
->sa_family
) {
392 return nfs_sockaddr_match_ipaddr4(sa1
, sa2
);
394 return nfs_sockaddr_match_ipaddr6(sa1
, sa2
);
398 #endif /* CONFIG_NFS_V4_1 */
401 * Test if two socket addresses represent the same actual socket,
402 * by comparing (only) relevant fields, including the port number.
404 static int nfs_sockaddr_cmp(const struct sockaddr
*sa1
,
405 const struct sockaddr
*sa2
)
407 if (sa1
->sa_family
!= sa2
->sa_family
)
410 switch (sa1
->sa_family
) {
412 return nfs_sockaddr_cmp_ip4(sa1
, sa2
);
414 return nfs_sockaddr_cmp_ip6(sa1
, sa2
);
420 * Find an nfs_client on the list that matches the initialisation data
423 static struct nfs_client
*nfs_match_client(const struct nfs_client_initdata
*data
)
425 struct nfs_client
*clp
;
426 const struct sockaddr
*sap
= data
->addr
;
427 struct nfs_net
*nn
= net_generic(data
->net
, nfs_net_id
);
429 list_for_each_entry(clp
, &nn
->nfs_client_list
, cl_share_link
) {
430 const struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
431 /* Don't match clients that failed to initialise properly */
432 if (clp
->cl_cons_state
< 0)
435 /* Different NFS versions cannot share the same nfs_client */
436 if (clp
->rpc_ops
!= data
->nfs_mod
->rpc_ops
)
439 if (clp
->cl_proto
!= data
->proto
)
441 /* Match nfsv4 minorversion */
442 if (clp
->cl_minorversion
!= data
->minorversion
)
444 /* Match the full socket address */
445 if (!nfs_sockaddr_cmp(sap
, clap
))
448 atomic_inc(&clp
->cl_count
);
454 static bool nfs_client_init_is_complete(const struct nfs_client
*clp
)
456 return clp
->cl_cons_state
!= NFS_CS_INITING
;
459 int nfs_wait_client_init_complete(const struct nfs_client
*clp
)
461 return wait_event_killable(nfs_client_active_wq
,
462 nfs_client_init_is_complete(clp
));
466 * Found an existing client. Make sure it's ready before returning.
468 static struct nfs_client
*
469 nfs_found_client(const struct nfs_client_initdata
*cl_init
,
470 struct nfs_client
*clp
)
474 error
= nfs_wait_client_init_complete(clp
);
477 return ERR_PTR(-ERESTARTSYS
);
480 if (clp
->cl_cons_state
< NFS_CS_READY
) {
481 error
= clp
->cl_cons_state
;
483 return ERR_PTR(error
);
488 dprintk("<-- %s found nfs_client %p for %s\n",
489 __func__
, clp
, cl_init
->hostname
?: "");
494 * Look up a client by IP address and protocol version
495 * - creates a new record if one doesn't yet exist
498 nfs_get_client(const struct nfs_client_initdata
*cl_init
,
499 const struct rpc_timeout
*timeparms
,
501 rpc_authflavor_t authflavour
)
503 struct nfs_client
*clp
, *new = NULL
;
504 struct nfs_net
*nn
= net_generic(cl_init
->net
, nfs_net_id
);
505 const struct nfs_rpc_ops
*rpc_ops
= cl_init
->nfs_mod
->rpc_ops
;
507 dprintk("--> nfs_get_client(%s,v%u)\n",
508 cl_init
->hostname
?: "", rpc_ops
->version
);
510 /* see if the client already exists */
512 spin_lock(&nn
->nfs_client_lock
);
514 clp
= nfs_match_client(cl_init
);
516 spin_unlock(&nn
->nfs_client_lock
);
518 new->rpc_ops
->free_client(new);
519 return nfs_found_client(cl_init
, clp
);
522 list_add(&new->cl_share_link
, &nn
->nfs_client_list
);
523 spin_unlock(&nn
->nfs_client_lock
);
524 new->cl_flags
= cl_init
->init_flags
;
525 return rpc_ops
->init_client(new, timeparms
, ip_addr
,
529 spin_unlock(&nn
->nfs_client_lock
);
531 new = rpc_ops
->alloc_client(cl_init
);
532 } while (!IS_ERR(new));
534 dprintk("<-- nfs_get_client() Failed to find %s (%ld)\n",
535 cl_init
->hostname
?: "", PTR_ERR(new));
540 * Mark a server as ready or failed
542 void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
545 clp
->cl_cons_state
= state
;
546 wake_up_all(&nfs_client_active_wq
);
550 * Initialise the timeout values for a connection
552 void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
553 unsigned int timeo
, unsigned int retrans
)
555 to
->to_initval
= timeo
* HZ
/ 10;
556 to
->to_retries
= retrans
;
559 case XPRT_TRANSPORT_TCP
:
560 case XPRT_TRANSPORT_RDMA
:
561 if (to
->to_retries
== 0)
562 to
->to_retries
= NFS_DEF_TCP_RETRANS
;
563 if (to
->to_initval
== 0)
564 to
->to_initval
= NFS_DEF_TCP_TIMEO
* HZ
/ 10;
565 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
566 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
567 to
->to_increment
= to
->to_initval
;
568 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
569 if (to
->to_maxval
> NFS_MAX_TCP_TIMEOUT
)
570 to
->to_maxval
= NFS_MAX_TCP_TIMEOUT
;
571 if (to
->to_maxval
< to
->to_initval
)
572 to
->to_maxval
= to
->to_initval
;
573 to
->to_exponential
= 0;
575 case XPRT_TRANSPORT_UDP
:
576 if (to
->to_retries
== 0)
577 to
->to_retries
= NFS_DEF_UDP_RETRANS
;
579 to
->to_initval
= NFS_DEF_UDP_TIMEO
* HZ
/ 10;
580 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
581 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
582 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
583 to
->to_exponential
= 1;
591 * Create an RPC client handle
593 int nfs_create_rpc_client(struct nfs_client
*clp
,
594 const struct rpc_timeout
*timeparms
,
595 rpc_authflavor_t flavor
)
597 struct rpc_clnt
*clnt
= NULL
;
598 struct rpc_create_args args
= {
600 .protocol
= clp
->cl_proto
,
601 .address
= (struct sockaddr
*)&clp
->cl_addr
,
602 .addrsize
= clp
->cl_addrlen
,
603 .timeout
= timeparms
,
604 .servername
= clp
->cl_hostname
,
605 .program
= &nfs_program
,
606 .version
= clp
->rpc_ops
->version
,
607 .authflavor
= flavor
,
610 if (test_bit(NFS_CS_DISCRTRY
, &clp
->cl_flags
))
611 args
.flags
|= RPC_CLNT_CREATE_DISCRTRY
;
612 if (test_bit(NFS_CS_NORESVPORT
, &clp
->cl_flags
))
613 args
.flags
|= RPC_CLNT_CREATE_NONPRIVPORT
;
615 if (!IS_ERR(clp
->cl_rpcclient
))
618 clnt
= rpc_create(&args
);
620 dprintk("%s: cannot create RPC client. Error = %ld\n",
621 __func__
, PTR_ERR(clnt
));
622 return PTR_ERR(clnt
);
625 clp
->cl_rpcclient
= clnt
;
630 * Version 2 or 3 client destruction
632 static void nfs_destroy_server(struct nfs_server
*server
)
634 if (!(server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) ||
635 !(server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
636 nlmclnt_done(server
->nlm_host
);
640 * Version 2 or 3 lockd setup
642 static int nfs_start_lockd(struct nfs_server
*server
)
644 struct nlm_host
*host
;
645 struct nfs_client
*clp
= server
->nfs_client
;
646 struct nlmclnt_initdata nlm_init
= {
647 .hostname
= clp
->cl_hostname
,
648 .address
= (struct sockaddr
*)&clp
->cl_addr
,
649 .addrlen
= clp
->cl_addrlen
,
650 .nfs_version
= clp
->rpc_ops
->version
,
651 .noresvport
= server
->flags
& NFS_MOUNT_NORESVPORT
?
656 if (nlm_init
.nfs_version
> 3)
658 if ((server
->flags
& NFS_MOUNT_LOCAL_FLOCK
) &&
659 (server
->flags
& NFS_MOUNT_LOCAL_FCNTL
))
662 switch (clp
->cl_proto
) {
664 nlm_init
.protocol
= IPPROTO_TCP
;
666 case XPRT_TRANSPORT_UDP
:
667 nlm_init
.protocol
= IPPROTO_UDP
;
670 host
= nlmclnt_init(&nlm_init
);
672 return PTR_ERR(host
);
674 server
->nlm_host
= host
;
675 server
->destroy
= nfs_destroy_server
;
680 * Create a general RPC client
682 int nfs_init_server_rpcclient(struct nfs_server
*server
,
683 const struct rpc_timeout
*timeo
,
684 rpc_authflavor_t pseudoflavour
)
686 struct nfs_client
*clp
= server
->nfs_client
;
688 server
->client
= rpc_clone_client(clp
->cl_rpcclient
);
689 if (IS_ERR(server
->client
)) {
690 dprintk("%s: couldn't create rpc_client!\n", __func__
);
691 return PTR_ERR(server
->client
);
694 memcpy(&server
->client
->cl_timeout_default
,
696 sizeof(server
->client
->cl_timeout_default
));
697 server
->client
->cl_timeout
= &server
->client
->cl_timeout_default
;
699 if (pseudoflavour
!= clp
->cl_rpcclient
->cl_auth
->au_flavor
) {
700 struct rpc_auth
*auth
;
702 auth
= rpcauth_create(pseudoflavour
, server
->client
);
704 dprintk("%s: couldn't create credcache!\n", __func__
);
705 return PTR_ERR(auth
);
708 server
->client
->cl_softrtry
= 0;
709 if (server
->flags
& NFS_MOUNT_SOFT
)
710 server
->client
->cl_softrtry
= 1;
716 * nfs_init_client - Initialise an NFS2 or NFS3 client
718 * @clp: nfs_client to initialise
719 * @timeparms: timeout parameters for underlying RPC transport
720 * @ip_addr: IP presentation address (not used)
721 * @authflavor: authentication flavor for underlying RPC transport
723 * Returns pointer to an NFS client, or an ERR_PTR value.
725 struct nfs_client
*nfs_init_client(struct nfs_client
*clp
,
726 const struct rpc_timeout
*timeparms
,
727 const char *ip_addr
, rpc_authflavor_t authflavour
)
731 if (clp
->cl_cons_state
== NFS_CS_READY
) {
732 /* the client is already initialised */
733 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp
);
738 * Create a client RPC handle for doing FSSTAT with UNIX auth only
739 * - RFC 2623, sec 2.3.2
741 error
= nfs_create_rpc_client(clp
, timeparms
, RPC_AUTH_UNIX
);
744 nfs_mark_client_ready(clp
, NFS_CS_READY
);
748 nfs_mark_client_ready(clp
, error
);
750 dprintk("<-- nfs_init_client() = xerror %d\n", error
);
751 return ERR_PTR(error
);
753 EXPORT_SYMBOL_GPL(nfs_init_client
);
756 * Create a version 2 or 3 client
758 static int nfs_init_server(struct nfs_server
*server
,
759 const struct nfs_parsed_mount_data
*data
,
760 struct nfs_subversion
*nfs_mod
)
762 struct nfs_client_initdata cl_init
= {
763 .hostname
= data
->nfs_server
.hostname
,
764 .addr
= (const struct sockaddr
*)&data
->nfs_server
.address
,
765 .addrlen
= data
->nfs_server
.addrlen
,
767 .proto
= data
->nfs_server
.protocol
,
770 struct rpc_timeout timeparms
;
771 struct nfs_client
*clp
;
774 dprintk("--> nfs_init_server()\n");
776 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
777 data
->timeo
, data
->retrans
);
778 if (data
->flags
& NFS_MOUNT_NORESVPORT
)
779 set_bit(NFS_CS_NORESVPORT
, &cl_init
.init_flags
);
781 /* Allocate or find a client reference we can use */
782 clp
= nfs_get_client(&cl_init
, &timeparms
, NULL
, RPC_AUTH_UNIX
);
784 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp
));
788 server
->nfs_client
= clp
;
790 /* Initialise the client representation from the mount data */
791 server
->flags
= data
->flags
;
792 server
->options
= data
->options
;
793 server
->caps
|= NFS_CAP_HARDLINKS
|NFS_CAP_SYMLINKS
|NFS_CAP_FILEID
|
794 NFS_CAP_MODE
|NFS_CAP_NLINK
|NFS_CAP_OWNER
|NFS_CAP_OWNER_GROUP
|
795 NFS_CAP_ATIME
|NFS_CAP_CTIME
|NFS_CAP_MTIME
|NFS_CAP_CHANGE_ATTR
;
798 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
800 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
802 server
->acregmin
= data
->acregmin
* HZ
;
803 server
->acregmax
= data
->acregmax
* HZ
;
804 server
->acdirmin
= data
->acdirmin
* HZ
;
805 server
->acdirmax
= data
->acdirmax
* HZ
;
807 /* Start lockd here, before we might error out */
808 error
= nfs_start_lockd(server
);
812 server
->port
= data
->nfs_server
.port
;
814 error
= nfs_init_server_rpcclient(server
, &timeparms
, data
->auth_flavors
[0]);
818 /* Preserve the values of mount_server-related mount options */
819 if (data
->mount_server
.addrlen
) {
820 memcpy(&server
->mountd_address
, &data
->mount_server
.address
,
821 data
->mount_server
.addrlen
);
822 server
->mountd_addrlen
= data
->mount_server
.addrlen
;
824 server
->mountd_version
= data
->mount_server
.version
;
825 server
->mountd_port
= data
->mount_server
.port
;
826 server
->mountd_protocol
= data
->mount_server
.protocol
;
828 server
->namelen
= data
->namlen
;
829 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp
);
833 server
->nfs_client
= NULL
;
835 dprintk("<-- nfs_init_server() = xerror %d\n", error
);
840 * Load up the server record from information gained in an fsinfo record
842 static void nfs_server_set_fsinfo(struct nfs_server
*server
,
843 struct nfs_fh
*mntfh
,
844 struct nfs_fsinfo
*fsinfo
)
846 unsigned long max_rpc_payload
;
848 /* Work out a lot of parameters */
849 if (server
->rsize
== 0)
850 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
851 if (server
->wsize
== 0)
852 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
854 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
855 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
856 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
857 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
859 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
860 if (server
->rsize
> max_rpc_payload
)
861 server
->rsize
= max_rpc_payload
;
862 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
863 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
864 server
->rpages
= (server
->rsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
866 server
->backing_dev_info
.name
= "nfs";
867 server
->backing_dev_info
.ra_pages
= server
->rpages
* NFS_MAX_READAHEAD
;
869 if (server
->wsize
> max_rpc_payload
)
870 server
->wsize
= max_rpc_payload
;
871 if (server
->wsize
> NFS_MAX_FILE_IO_SIZE
)
872 server
->wsize
= NFS_MAX_FILE_IO_SIZE
;
873 server
->wpages
= (server
->wsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
874 server
->pnfs_blksize
= fsinfo
->blksize
;
876 server
->wtmult
= nfs_block_bits(fsinfo
->wtmult
, NULL
);
878 server
->dtsize
= nfs_block_size(fsinfo
->dtpref
, NULL
);
879 if (server
->dtsize
> PAGE_CACHE_SIZE
* NFS_MAX_READDIR_PAGES
)
880 server
->dtsize
= PAGE_CACHE_SIZE
* NFS_MAX_READDIR_PAGES
;
881 if (server
->dtsize
> server
->rsize
)
882 server
->dtsize
= server
->rsize
;
884 if (server
->flags
& NFS_MOUNT_NOAC
) {
885 server
->acregmin
= server
->acregmax
= 0;
886 server
->acdirmin
= server
->acdirmax
= 0;
889 server
->maxfilesize
= fsinfo
->maxfilesize
;
891 server
->time_delta
= fsinfo
->time_delta
;
893 /* We're airborne Set socket buffersize */
894 rpc_setbufsize(server
->client
, server
->wsize
+ 100, server
->rsize
+ 100);
898 * Probe filesystem information, including the FSID on v2/v3
900 int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*mntfh
, struct nfs_fattr
*fattr
)
902 struct nfs_fsinfo fsinfo
;
903 struct nfs_client
*clp
= server
->nfs_client
;
906 dprintk("--> nfs_probe_fsinfo()\n");
908 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
909 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
914 fsinfo
.fattr
= fattr
;
915 fsinfo
.layouttype
= 0;
916 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
920 nfs_server_set_fsinfo(server
, mntfh
, &fsinfo
);
922 /* Get some general file system info */
923 if (server
->namelen
== 0) {
924 struct nfs_pathconf pathinfo
;
926 pathinfo
.fattr
= fattr
;
927 nfs_fattr_init(fattr
);
929 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
930 server
->namelen
= pathinfo
.max_namelen
;
933 dprintk("<-- nfs_probe_fsinfo() = 0\n");
937 dprintk("nfs_probe_fsinfo: error = %d\n", -error
);
942 * Copy useful information when duplicating a server record
944 void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
946 target
->flags
= source
->flags
;
947 target
->rsize
= source
->rsize
;
948 target
->wsize
= source
->wsize
;
949 target
->acregmin
= source
->acregmin
;
950 target
->acregmax
= source
->acregmax
;
951 target
->acdirmin
= source
->acdirmin
;
952 target
->acdirmax
= source
->acdirmax
;
953 target
->caps
= source
->caps
;
954 target
->options
= source
->options
;
957 void nfs_server_insert_lists(struct nfs_server
*server
)
959 struct nfs_client
*clp
= server
->nfs_client
;
960 struct nfs_net
*nn
= net_generic(clp
->cl_net
, nfs_net_id
);
962 spin_lock(&nn
->nfs_client_lock
);
963 list_add_tail_rcu(&server
->client_link
, &clp
->cl_superblocks
);
964 list_add_tail(&server
->master_link
, &nn
->nfs_volume_list
);
965 clear_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
966 spin_unlock(&nn
->nfs_client_lock
);
970 static void nfs_server_remove_lists(struct nfs_server
*server
)
972 struct nfs_client
*clp
= server
->nfs_client
;
977 nn
= net_generic(clp
->cl_net
, nfs_net_id
);
978 spin_lock(&nn
->nfs_client_lock
);
979 list_del_rcu(&server
->client_link
);
980 if (list_empty(&clp
->cl_superblocks
))
981 set_bit(NFS_CS_STOP_RENEW
, &clp
->cl_res_state
);
982 list_del(&server
->master_link
);
983 spin_unlock(&nn
->nfs_client_lock
);
989 * Allocate and initialise a server record
991 struct nfs_server
*nfs_alloc_server(void)
993 struct nfs_server
*server
;
995 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
999 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
1001 /* Zero out the NFS state stuff */
1002 INIT_LIST_HEAD(&server
->client_link
);
1003 INIT_LIST_HEAD(&server
->master_link
);
1004 INIT_LIST_HEAD(&server
->delegations
);
1005 INIT_LIST_HEAD(&server
->layouts
);
1006 INIT_LIST_HEAD(&server
->state_owners_lru
);
1008 atomic_set(&server
->active
, 0);
1010 server
->io_stats
= nfs_alloc_iostats();
1011 if (!server
->io_stats
) {
1016 if (bdi_init(&server
->backing_dev_info
)) {
1017 nfs_free_iostats(server
->io_stats
);
1022 ida_init(&server
->openowner_id
);
1023 ida_init(&server
->lockowner_id
);
1024 pnfs_init_server(server
);
1030 * Free up a server record
1032 void nfs_free_server(struct nfs_server
*server
)
1034 dprintk("--> nfs_free_server()\n");
1036 nfs_server_remove_lists(server
);
1038 if (server
->destroy
!= NULL
)
1039 server
->destroy(server
);
1041 if (!IS_ERR(server
->client_acl
))
1042 rpc_shutdown_client(server
->client_acl
);
1043 if (!IS_ERR(server
->client
))
1044 rpc_shutdown_client(server
->client
);
1046 nfs_put_client(server
->nfs_client
);
1048 ida_destroy(&server
->lockowner_id
);
1049 ida_destroy(&server
->openowner_id
);
1050 nfs_free_iostats(server
->io_stats
);
1051 bdi_destroy(&server
->backing_dev_info
);
1053 nfs_release_automount_timer();
1054 dprintk("<-- nfs_free_server()\n");
1058 * Create a version 2 or 3 volume record
1059 * - keyed on server and FSID
1061 struct nfs_server
*nfs_create_server(struct nfs_mount_info
*mount_info
,
1062 struct nfs_subversion
*nfs_mod
)
1064 struct nfs_server
*server
;
1065 struct nfs_fattr
*fattr
;
1068 server
= nfs_alloc_server();
1070 return ERR_PTR(-ENOMEM
);
1073 fattr
= nfs_alloc_fattr();
1077 /* Get a client representation */
1078 error
= nfs_init_server(server
, mount_info
->parsed
, nfs_mod
);
1082 BUG_ON(!server
->nfs_client
);
1083 BUG_ON(!server
->nfs_client
->rpc_ops
);
1084 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1086 /* Probe the root fh to retrieve its FSID */
1087 error
= nfs_probe_fsinfo(server
, mount_info
->mntfh
, fattr
);
1090 if (server
->nfs_client
->rpc_ops
->version
== 3) {
1091 if (server
->namelen
== 0 || server
->namelen
> NFS3_MAXNAMLEN
)
1092 server
->namelen
= NFS3_MAXNAMLEN
;
1093 if (!(mount_info
->parsed
->flags
& NFS_MOUNT_NORDIRPLUS
))
1094 server
->caps
|= NFS_CAP_READDIRPLUS
;
1096 if (server
->namelen
== 0 || server
->namelen
> NFS2_MAXNAMLEN
)
1097 server
->namelen
= NFS2_MAXNAMLEN
;
1100 if (!(fattr
->valid
& NFS_ATTR_FATTR
)) {
1101 error
= nfs_mod
->rpc_ops
->getattr(server
, mount_info
->mntfh
, fattr
);
1103 dprintk("nfs_create_server: getattr error = %d\n", -error
);
1107 memcpy(&server
->fsid
, &fattr
->fsid
, sizeof(server
->fsid
));
1109 dprintk("Server FSID: %llx:%llx\n",
1110 (unsigned long long) server
->fsid
.major
,
1111 (unsigned long long) server
->fsid
.minor
);
1113 nfs_server_insert_lists(server
);
1114 server
->mount_time
= jiffies
;
1115 nfs_free_fattr(fattr
);
1119 nfs_free_fattr(fattr
);
1120 nfs_free_server(server
);
1121 return ERR_PTR(error
);
1123 EXPORT_SYMBOL_GPL(nfs_create_server
);
1126 * Clone an NFS2, NFS3 or NFS4 server record
1128 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
1130 struct nfs_fattr
*fattr
,
1131 rpc_authflavor_t flavor
)
1133 struct nfs_server
*server
;
1134 struct nfs_fattr
*fattr_fsinfo
;
1137 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1138 (unsigned long long) fattr
->fsid
.major
,
1139 (unsigned long long) fattr
->fsid
.minor
);
1141 server
= nfs_alloc_server();
1143 return ERR_PTR(-ENOMEM
);
1146 fattr_fsinfo
= nfs_alloc_fattr();
1147 if (fattr_fsinfo
== NULL
)
1148 goto out_free_server
;
1150 /* Copy data from the source */
1151 server
->nfs_client
= source
->nfs_client
;
1152 server
->destroy
= source
->destroy
;
1153 atomic_inc(&server
->nfs_client
->cl_count
);
1154 nfs_server_copy_userdata(server
, source
);
1156 server
->fsid
= fattr
->fsid
;
1158 error
= nfs_init_server_rpcclient(server
,
1159 source
->client
->cl_timeout
,
1162 goto out_free_server
;
1164 /* probe the filesystem info for this server filesystem */
1165 error
= nfs_probe_fsinfo(server
, fh
, fattr_fsinfo
);
1167 goto out_free_server
;
1169 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1170 server
->namelen
= NFS4_MAXNAMLEN
;
1172 dprintk("Cloned FSID: %llx:%llx\n",
1173 (unsigned long long) server
->fsid
.major
,
1174 (unsigned long long) server
->fsid
.minor
);
1176 error
= nfs_start_lockd(server
);
1178 goto out_free_server
;
1180 nfs_server_insert_lists(server
);
1181 server
->mount_time
= jiffies
;
1183 nfs_free_fattr(fattr_fsinfo
);
1184 dprintk("<-- nfs_clone_server() = %p\n", server
);
1188 nfs_free_fattr(fattr_fsinfo
);
1189 nfs_free_server(server
);
1190 dprintk("<-- nfs_clone_server() = error %d\n", error
);
1191 return ERR_PTR(error
);
1193 EXPORT_SYMBOL_GPL(nfs_clone_server
);
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 */