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>
39 #include <linux/nfs_xdr.h>
41 #include <asm/system.h>
45 #include "delegation.h"
49 #define NFSDBG_FACILITY NFSDBG_CLIENT
51 static DEFINE_SPINLOCK(nfs_client_lock
);
52 static LIST_HEAD(nfs_client_list
);
53 static LIST_HEAD(nfs_volume_list
);
54 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq
);
59 static struct rpc_version
*nfs_version
[5] = {
69 struct rpc_program nfs_program
= {
71 .number
= NFS_PROGRAM
,
72 .nrvers
= ARRAY_SIZE(nfs_version
),
73 .version
= nfs_version
,
74 .stats
= &nfs_rpcstat
,
75 .pipe_dir_name
= "/nfs",
78 struct rpc_stat nfs_rpcstat
= {
79 .program
= &nfs_program
83 #ifdef CONFIG_NFS_V3_ACL
84 static struct rpc_stat nfsacl_rpcstat
= { &nfsacl_program
};
85 static struct rpc_version
* nfsacl_version
[] = {
86 [3] = &nfsacl_version3
,
89 struct rpc_program nfsacl_program
= {
91 .number
= NFS_ACL_PROGRAM
,
92 .nrvers
= ARRAY_SIZE(nfsacl_version
),
93 .version
= nfsacl_version
,
94 .stats
= &nfsacl_rpcstat
,
96 #endif /* CONFIG_NFS_V3_ACL */
98 struct nfs_client_initdata
{
100 const struct sockaddr
*addr
;
102 const struct nfs_rpc_ops
*rpc_ops
;
106 * Allocate a shared client record
108 * Since these are allocated/deallocated very rarely, we don't
109 * bother putting them in a slab cache...
111 static struct nfs_client
*nfs_alloc_client(const struct nfs_client_initdata
*cl_init
)
113 struct nfs_client
*clp
;
115 if ((clp
= kzalloc(sizeof(*clp
), GFP_KERNEL
)) == NULL
)
118 clp
->rpc_ops
= cl_init
->rpc_ops
;
120 if (cl_init
->rpc_ops
->version
== 4) {
121 if (nfs_callback_up() < 0)
123 __set_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
);
126 atomic_set(&clp
->cl_count
, 1);
127 clp
->cl_cons_state
= NFS_CS_INITING
;
129 memcpy(&clp
->cl_addr
, cl_init
->addr
, cl_init
->addrlen
);
130 clp
->cl_addrlen
= cl_init
->addrlen
;
132 if (cl_init
->hostname
) {
133 clp
->cl_hostname
= kstrdup(cl_init
->hostname
, GFP_KERNEL
);
134 if (!clp
->cl_hostname
)
138 INIT_LIST_HEAD(&clp
->cl_superblocks
);
139 clp
->cl_rpcclient
= ERR_PTR(-EINVAL
);
142 init_rwsem(&clp
->cl_sem
);
143 INIT_LIST_HEAD(&clp
->cl_delegations
);
144 spin_lock_init(&clp
->cl_lock
);
145 INIT_DELAYED_WORK(&clp
->cl_renewd
, nfs4_renew_state
);
146 rpc_init_wait_queue(&clp
->cl_rpcwaitq
, "NFS client");
147 clp
->cl_boot_time
= CURRENT_TIME
;
148 clp
->cl_state
= 1 << NFS4CLNT_LEASE_EXPIRED
;
154 if (__test_and_clear_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
))
162 static void nfs4_shutdown_client(struct nfs_client
*clp
)
165 if (__test_and_clear_bit(NFS_CS_RENEWD
, &clp
->cl_res_state
))
166 nfs4_kill_renewd(clp
);
167 BUG_ON(!RB_EMPTY_ROOT(&clp
->cl_state_owners
));
168 if (__test_and_clear_bit(NFS_CS_IDMAP
, &clp
->cl_res_state
))
169 nfs_idmap_delete(clp
);
174 * Destroy a shared client record
176 static void nfs_free_client(struct nfs_client
*clp
)
178 dprintk("--> nfs_free_client(%u)\n", clp
->rpc_ops
->version
);
180 nfs4_shutdown_client(clp
);
182 /* -EIO all pending I/O */
183 if (!IS_ERR(clp
->cl_rpcclient
))
184 rpc_shutdown_client(clp
->cl_rpcclient
);
186 if (__test_and_clear_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
))
189 kfree(clp
->cl_hostname
);
192 dprintk("<-- nfs_free_client()\n");
196 * Release a reference to a shared client record
198 void nfs_put_client(struct nfs_client
*clp
)
203 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp
->cl_count
));
205 if (atomic_dec_and_lock(&clp
->cl_count
, &nfs_client_lock
)) {
206 list_del(&clp
->cl_share_link
);
207 spin_unlock(&nfs_client_lock
);
209 BUG_ON(!list_empty(&clp
->cl_superblocks
));
211 nfs_free_client(clp
);
215 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr_in
*sa1
,
216 const struct sockaddr_in
*sa2
)
218 return sa1
->sin_addr
.s_addr
== sa2
->sin_addr
.s_addr
;
221 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr_in6
*sa1
,
222 const struct sockaddr_in6
*sa2
)
224 return ipv6_addr_equal(&sa1
->sin6_addr
, &sa2
->sin6_addr
);
227 static int nfs_sockaddr_match_ipaddr(const struct sockaddr
*sa1
,
228 const struct sockaddr
*sa2
)
230 switch (sa1
->sa_family
) {
232 return nfs_sockaddr_match_ipaddr4((const struct sockaddr_in
*)sa1
,
233 (const struct sockaddr_in
*)sa2
);
235 return nfs_sockaddr_match_ipaddr6((const struct sockaddr_in6
*)sa1
,
236 (const struct sockaddr_in6
*)sa2
);
242 * Find a client by IP address and protocol version
243 * - returns NULL if no such client
245 struct nfs_client
*nfs_find_client(const struct sockaddr
*addr
, u32 nfsversion
)
247 struct nfs_client
*clp
;
249 spin_lock(&nfs_client_lock
);
250 list_for_each_entry(clp
, &nfs_client_list
, cl_share_link
) {
251 struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
253 /* Don't match clients that failed to initialise properly */
254 if (clp
->cl_cons_state
!= NFS_CS_READY
)
257 /* Different NFS versions cannot share the same nfs_client */
258 if (clp
->rpc_ops
->version
!= nfsversion
)
261 if (addr
->sa_family
!= clap
->sa_family
)
263 /* Match only the IP address, not the port number */
264 if (!nfs_sockaddr_match_ipaddr(addr
, clap
))
267 atomic_inc(&clp
->cl_count
);
268 spin_unlock(&nfs_client_lock
);
271 spin_unlock(&nfs_client_lock
);
276 * Find an nfs_client on the list that matches the initialisation data
279 static struct nfs_client
*nfs_match_client(const struct nfs_client_initdata
*data
)
281 struct nfs_client
*clp
;
283 list_for_each_entry(clp
, &nfs_client_list
, cl_share_link
) {
284 /* Don't match clients that failed to initialise properly */
285 if (clp
->cl_cons_state
< 0)
288 /* Different NFS versions cannot share the same nfs_client */
289 if (clp
->rpc_ops
!= data
->rpc_ops
)
292 /* Match the full socket address */
293 if (memcmp(&clp
->cl_addr
, data
->addr
, sizeof(clp
->cl_addr
)) != 0)
296 atomic_inc(&clp
->cl_count
);
303 * Look up a client by IP address and protocol version
304 * - creates a new record if one doesn't yet exist
306 static struct nfs_client
*nfs_get_client(const struct nfs_client_initdata
*cl_init
)
308 struct nfs_client
*clp
, *new = NULL
;
311 dprintk("--> nfs_get_client(%s,v%u)\n",
312 cl_init
->hostname
?: "", cl_init
->rpc_ops
->version
);
314 /* see if the client already exists */
316 spin_lock(&nfs_client_lock
);
318 clp
= nfs_match_client(cl_init
);
324 spin_unlock(&nfs_client_lock
);
326 new = nfs_alloc_client(cl_init
);
329 return ERR_PTR(-ENOMEM
);
331 /* install a new client and return with it unready */
334 list_add(&clp
->cl_share_link
, &nfs_client_list
);
335 spin_unlock(&nfs_client_lock
);
336 dprintk("--> nfs_get_client() = %p [new]\n", clp
);
339 /* found an existing client
340 * - make sure it's ready before returning
343 spin_unlock(&nfs_client_lock
);
346 nfs_free_client(new);
348 error
= wait_event_interruptible(nfs_client_active_wq
,
349 clp
->cl_cons_state
!= NFS_CS_INITING
);
352 return ERR_PTR(-ERESTARTSYS
);
355 if (clp
->cl_cons_state
< NFS_CS_READY
) {
356 error
= clp
->cl_cons_state
;
358 return ERR_PTR(error
);
361 BUG_ON(clp
->cl_cons_state
!= NFS_CS_READY
);
363 dprintk("--> nfs_get_client() = %p [share]\n", clp
);
368 * Mark a server as ready or failed
370 static void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
372 clp
->cl_cons_state
= state
;
373 wake_up_all(&nfs_client_active_wq
);
377 * Initialise the timeout values for a connection
379 static void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
380 unsigned int timeo
, unsigned int retrans
)
382 to
->to_initval
= timeo
* HZ
/ 10;
383 to
->to_retries
= retrans
;
388 case XPRT_TRANSPORT_TCP
:
389 case XPRT_TRANSPORT_RDMA
:
390 if (to
->to_initval
== 0)
391 to
->to_initval
= 60 * HZ
;
392 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
393 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
394 to
->to_increment
= to
->to_initval
;
395 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
396 if (to
->to_maxval
> NFS_MAX_TCP_TIMEOUT
)
397 to
->to_maxval
= NFS_MAX_TCP_TIMEOUT
;
398 if (to
->to_maxval
< to
->to_initval
)
399 to
->to_maxval
= to
->to_initval
;
400 to
->to_exponential
= 0;
402 case XPRT_TRANSPORT_UDP
:
405 to
->to_initval
= 11 * HZ
/ 10;
406 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
407 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
408 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
409 to
->to_exponential
= 1;
415 * Create an RPC client handle
417 static int nfs_create_rpc_client(struct nfs_client
*clp
, int proto
,
418 const struct rpc_timeout
*timeparms
,
419 rpc_authflavor_t flavor
,
422 struct rpc_clnt
*clnt
= NULL
;
423 struct rpc_create_args args
= {
425 .address
= (struct sockaddr
*)&clp
->cl_addr
,
426 .addrsize
= clp
->cl_addrlen
,
427 .timeout
= timeparms
,
428 .servername
= clp
->cl_hostname
,
429 .program
= &nfs_program
,
430 .version
= clp
->rpc_ops
->version
,
431 .authflavor
= flavor
,
435 if (!IS_ERR(clp
->cl_rpcclient
))
438 clnt
= rpc_create(&args
);
440 dprintk("%s: cannot create RPC client. Error = %ld\n",
441 __FUNCTION__
, PTR_ERR(clnt
));
442 return PTR_ERR(clnt
);
445 clp
->cl_rpcclient
= clnt
;
450 * Version 2 or 3 client destruction
452 static void nfs_destroy_server(struct nfs_server
*server
)
454 if (!(server
->flags
& NFS_MOUNT_NONLM
))
455 lockd_down(); /* release rpc.lockd */
459 * Version 2 or 3 lockd setup
461 static int nfs_start_lockd(struct nfs_server
*server
)
465 if (server
->nfs_client
->rpc_ops
->version
> 3)
467 if (server
->flags
& NFS_MOUNT_NONLM
)
469 error
= lockd_up((server
->flags
& NFS_MOUNT_TCP
) ?
470 IPPROTO_TCP
: IPPROTO_UDP
);
472 server
->flags
|= NFS_MOUNT_NONLM
;
474 server
->destroy
= nfs_destroy_server
;
480 * Initialise an NFSv3 ACL client connection
482 #ifdef CONFIG_NFS_V3_ACL
483 static void nfs_init_server_aclclient(struct nfs_server
*server
)
485 if (server
->nfs_client
->rpc_ops
->version
!= 3)
487 if (server
->flags
& NFS_MOUNT_NOACL
)
490 server
->client_acl
= rpc_bind_new_program(server
->client
, &nfsacl_program
, 3);
491 if (IS_ERR(server
->client_acl
))
494 /* No errors! Assume that Sun nfsacls are supported */
495 server
->caps
|= NFS_CAP_ACLS
;
499 server
->caps
&= ~NFS_CAP_ACLS
;
502 static inline void nfs_init_server_aclclient(struct nfs_server
*server
)
504 server
->flags
&= ~NFS_MOUNT_NOACL
;
505 server
->caps
&= ~NFS_CAP_ACLS
;
510 * Create a general RPC client
512 static int nfs_init_server_rpcclient(struct nfs_server
*server
,
513 const struct rpc_timeout
*timeo
,
514 rpc_authflavor_t pseudoflavour
)
516 struct nfs_client
*clp
= server
->nfs_client
;
518 server
->client
= rpc_clone_client(clp
->cl_rpcclient
);
519 if (IS_ERR(server
->client
)) {
520 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__
);
521 return PTR_ERR(server
->client
);
524 memcpy(&server
->client
->cl_timeout_default
,
526 sizeof(server
->client
->cl_timeout_default
));
527 server
->client
->cl_timeout
= &server
->client
->cl_timeout_default
;
529 if (pseudoflavour
!= clp
->cl_rpcclient
->cl_auth
->au_flavor
) {
530 struct rpc_auth
*auth
;
532 auth
= rpcauth_create(pseudoflavour
, server
->client
);
534 dprintk("%s: couldn't create credcache!\n", __FUNCTION__
);
535 return PTR_ERR(auth
);
538 server
->client
->cl_softrtry
= 0;
539 if (server
->flags
& NFS_MOUNT_SOFT
)
540 server
->client
->cl_softrtry
= 1;
542 server
->client
->cl_intr
= 0;
543 if (server
->flags
& NFS4_MOUNT_INTR
)
544 server
->client
->cl_intr
= 1;
550 * Initialise an NFS2 or NFS3 client
552 static int nfs_init_client(struct nfs_client
*clp
,
553 const struct rpc_timeout
*timeparms
,
554 const struct nfs_parsed_mount_data
*data
)
558 if (clp
->cl_cons_state
== NFS_CS_READY
) {
559 /* the client is already initialised */
560 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp
);
565 * Create a client RPC handle for doing FSSTAT with UNIX auth only
566 * - RFC 2623, sec 2.3.2
568 error
= nfs_create_rpc_client(clp
, data
->nfs_server
.protocol
,
569 timeparms
, RPC_AUTH_UNIX
, 0);
572 nfs_mark_client_ready(clp
, NFS_CS_READY
);
576 nfs_mark_client_ready(clp
, error
);
577 dprintk("<-- nfs_init_client() = xerror %d\n", error
);
582 * Create a version 2 or 3 client
584 static int nfs_init_server(struct nfs_server
*server
,
585 const struct nfs_parsed_mount_data
*data
)
587 struct nfs_client_initdata cl_init
= {
588 .hostname
= data
->nfs_server
.hostname
,
589 .addr
= (const struct sockaddr
*)&data
->nfs_server
.address
,
590 .addrlen
= data
->nfs_server
.addrlen
,
591 .rpc_ops
= &nfs_v2_clientops
,
593 struct rpc_timeout timeparms
;
594 struct nfs_client
*clp
;
597 dprintk("--> nfs_init_server()\n");
600 if (data
->flags
& NFS_MOUNT_VER3
)
601 cl_init
.rpc_ops
= &nfs_v3_clientops
;
604 /* Allocate or find a client reference we can use */
605 clp
= nfs_get_client(&cl_init
);
607 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp
));
611 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
612 data
->timeo
, data
->retrans
);
613 error
= nfs_init_client(clp
, &timeparms
, data
);
617 server
->nfs_client
= clp
;
619 /* Initialise the client representation from the mount data */
620 server
->flags
= data
->flags
& NFS_MOUNT_FLAGMASK
;
623 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
625 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
627 server
->acregmin
= data
->acregmin
* HZ
;
628 server
->acregmax
= data
->acregmax
* HZ
;
629 server
->acdirmin
= data
->acdirmin
* HZ
;
630 server
->acdirmax
= data
->acdirmax
* HZ
;
632 /* Start lockd here, before we might error out */
633 error
= nfs_start_lockd(server
);
637 error
= nfs_init_server_rpcclient(server
, &timeparms
, data
->auth_flavors
[0]);
641 server
->namelen
= data
->namlen
;
642 /* Create a client RPC handle for the NFSv3 ACL management interface */
643 nfs_init_server_aclclient(server
);
644 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp
);
648 server
->nfs_client
= NULL
;
650 dprintk("<-- nfs_init_server() = xerror %d\n", error
);
655 * Load up the server record from information gained in an fsinfo record
657 static void nfs_server_set_fsinfo(struct nfs_server
*server
, struct nfs_fsinfo
*fsinfo
)
659 unsigned long max_rpc_payload
;
661 /* Work out a lot of parameters */
662 if (server
->rsize
== 0)
663 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
664 if (server
->wsize
== 0)
665 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
667 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
668 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
669 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
670 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
672 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
673 if (server
->rsize
> max_rpc_payload
)
674 server
->rsize
= max_rpc_payload
;
675 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
676 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
677 server
->rpages
= (server
->rsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
679 server
->backing_dev_info
.ra_pages
= server
->rpages
* NFS_MAX_READAHEAD
;
681 if (server
->wsize
> max_rpc_payload
)
682 server
->wsize
= max_rpc_payload
;
683 if (server
->wsize
> NFS_MAX_FILE_IO_SIZE
)
684 server
->wsize
= NFS_MAX_FILE_IO_SIZE
;
685 server
->wpages
= (server
->wsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
686 server
->wtmult
= nfs_block_bits(fsinfo
->wtmult
, NULL
);
688 server
->dtsize
= nfs_block_size(fsinfo
->dtpref
, NULL
);
689 if (server
->dtsize
> PAGE_CACHE_SIZE
)
690 server
->dtsize
= PAGE_CACHE_SIZE
;
691 if (server
->dtsize
> server
->rsize
)
692 server
->dtsize
= server
->rsize
;
694 if (server
->flags
& NFS_MOUNT_NOAC
) {
695 server
->acregmin
= server
->acregmax
= 0;
696 server
->acdirmin
= server
->acdirmax
= 0;
699 server
->maxfilesize
= fsinfo
->maxfilesize
;
701 /* We're airborne Set socket buffersize */
702 rpc_setbufsize(server
->client
, server
->wsize
+ 100, server
->rsize
+ 100);
706 * Probe filesystem information, including the FSID on v2/v3
708 static int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*mntfh
, struct nfs_fattr
*fattr
)
710 struct nfs_fsinfo fsinfo
;
711 struct nfs_client
*clp
= server
->nfs_client
;
714 dprintk("--> nfs_probe_fsinfo()\n");
716 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
717 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
722 fsinfo
.fattr
= fattr
;
723 nfs_fattr_init(fattr
);
724 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
728 nfs_server_set_fsinfo(server
, &fsinfo
);
729 error
= bdi_init(&server
->backing_dev_info
);
734 /* Get some general file system info */
735 if (server
->namelen
== 0) {
736 struct nfs_pathconf pathinfo
;
738 pathinfo
.fattr
= fattr
;
739 nfs_fattr_init(fattr
);
741 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
742 server
->namelen
= pathinfo
.max_namelen
;
745 dprintk("<-- nfs_probe_fsinfo() = 0\n");
749 dprintk("nfs_probe_fsinfo: error = %d\n", -error
);
754 * Copy useful information when duplicating a server record
756 static void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
758 target
->flags
= source
->flags
;
759 target
->acregmin
= source
->acregmin
;
760 target
->acregmax
= source
->acregmax
;
761 target
->acdirmin
= source
->acdirmin
;
762 target
->acdirmax
= source
->acdirmax
;
763 target
->caps
= source
->caps
;
767 * Allocate and initialise a server record
769 static struct nfs_server
*nfs_alloc_server(void)
771 struct nfs_server
*server
;
773 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
777 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
779 /* Zero out the NFS state stuff */
780 INIT_LIST_HEAD(&server
->client_link
);
781 INIT_LIST_HEAD(&server
->master_link
);
783 init_waitqueue_head(&server
->active_wq
);
784 atomic_set(&server
->active
, 0);
786 server
->io_stats
= nfs_alloc_iostats();
787 if (!server
->io_stats
) {
796 * Free up a server record
798 void nfs_free_server(struct nfs_server
*server
)
800 dprintk("--> nfs_free_server()\n");
802 spin_lock(&nfs_client_lock
);
803 list_del(&server
->client_link
);
804 list_del(&server
->master_link
);
805 spin_unlock(&nfs_client_lock
);
807 if (server
->destroy
!= NULL
)
808 server
->destroy(server
);
810 if (!IS_ERR(server
->client_acl
))
811 rpc_shutdown_client(server
->client_acl
);
812 if (!IS_ERR(server
->client
))
813 rpc_shutdown_client(server
->client
);
815 nfs_put_client(server
->nfs_client
);
817 nfs_free_iostats(server
->io_stats
);
818 bdi_destroy(&server
->backing_dev_info
);
820 nfs_release_automount_timer();
821 dprintk("<-- nfs_free_server()\n");
825 * Create a version 2 or 3 volume record
826 * - keyed on server and FSID
828 struct nfs_server
*nfs_create_server(const struct nfs_parsed_mount_data
*data
,
829 struct nfs_fh
*mntfh
)
831 struct nfs_server
*server
;
832 struct nfs_fattr fattr
;
835 server
= nfs_alloc_server();
837 return ERR_PTR(-ENOMEM
);
839 /* Get a client representation */
840 error
= nfs_init_server(server
, data
);
844 BUG_ON(!server
->nfs_client
);
845 BUG_ON(!server
->nfs_client
->rpc_ops
);
846 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
848 /* Probe the root fh to retrieve its FSID */
849 error
= nfs_probe_fsinfo(server
, mntfh
, &fattr
);
852 if (server
->nfs_client
->rpc_ops
->version
== 3) {
853 if (server
->namelen
== 0 || server
->namelen
> NFS3_MAXNAMLEN
)
854 server
->namelen
= NFS3_MAXNAMLEN
;
855 if (!(data
->flags
& NFS_MOUNT_NORDIRPLUS
))
856 server
->caps
|= NFS_CAP_READDIRPLUS
;
858 if (server
->namelen
== 0 || server
->namelen
> NFS2_MAXNAMLEN
)
859 server
->namelen
= NFS2_MAXNAMLEN
;
862 if (!(fattr
.valid
& NFS_ATTR_FATTR
)) {
863 error
= server
->nfs_client
->rpc_ops
->getattr(server
, mntfh
, &fattr
);
865 dprintk("nfs_create_server: getattr error = %d\n", -error
);
869 memcpy(&server
->fsid
, &fattr
.fsid
, sizeof(server
->fsid
));
871 dprintk("Server FSID: %llx:%llx\n",
872 (unsigned long long) server
->fsid
.major
,
873 (unsigned long long) server
->fsid
.minor
);
875 BUG_ON(!server
->nfs_client
);
876 BUG_ON(!server
->nfs_client
->rpc_ops
);
877 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
879 spin_lock(&nfs_client_lock
);
880 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
881 list_add_tail(&server
->master_link
, &nfs_volume_list
);
882 spin_unlock(&nfs_client_lock
);
884 server
->mount_time
= jiffies
;
888 nfs_free_server(server
);
889 return ERR_PTR(error
);
894 * Initialise an NFS4 client record
896 static int nfs4_init_client(struct nfs_client
*clp
,
898 const struct rpc_timeout
*timeparms
,
900 rpc_authflavor_t authflavour
)
904 if (clp
->cl_cons_state
== NFS_CS_READY
) {
905 /* the client is initialised already */
906 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp
);
910 /* Check NFS protocol revision and initialize RPC op vector */
911 clp
->rpc_ops
= &nfs_v4_clientops
;
913 error
= nfs_create_rpc_client(clp
, proto
, timeparms
, authflavour
,
914 RPC_CLNT_CREATE_DISCRTRY
);
917 memcpy(clp
->cl_ipaddr
, ip_addr
, sizeof(clp
->cl_ipaddr
));
919 error
= nfs_idmap_new(clp
);
921 dprintk("%s: failed to create idmapper. Error = %d\n",
922 __FUNCTION__
, error
);
925 __set_bit(NFS_CS_IDMAP
, &clp
->cl_res_state
);
927 nfs_mark_client_ready(clp
, NFS_CS_READY
);
931 nfs_mark_client_ready(clp
, error
);
932 dprintk("<-- nfs4_init_client() = xerror %d\n", error
);
937 * Set up an NFS4 client
939 static int nfs4_set_client(struct nfs_server
*server
,
940 const char *hostname
,
941 const struct sockaddr
*addr
,
942 const size_t addrlen
,
944 rpc_authflavor_t authflavour
,
945 int proto
, const struct rpc_timeout
*timeparms
)
947 struct nfs_client_initdata cl_init
= {
948 .hostname
= hostname
,
951 .rpc_ops
= &nfs_v4_clientops
,
953 struct nfs_client
*clp
;
956 dprintk("--> nfs4_set_client()\n");
958 /* Allocate or find a client reference we can use */
959 clp
= nfs_get_client(&cl_init
);
961 error
= PTR_ERR(clp
);
964 error
= nfs4_init_client(clp
, proto
, timeparms
, ip_addr
, authflavour
);
968 server
->nfs_client
= clp
;
969 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp
);
975 dprintk("<-- nfs4_set_client() = xerror %d\n", error
);
980 * Create a version 4 volume record
982 static int nfs4_init_server(struct nfs_server
*server
,
983 const struct nfs_parsed_mount_data
*data
)
985 struct rpc_timeout timeparms
;
988 dprintk("--> nfs4_init_server()\n");
990 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
991 data
->timeo
, data
->retrans
);
993 /* Get a client record */
994 error
= nfs4_set_client(server
,
995 data
->nfs_server
.hostname
,
996 (const struct sockaddr
*)&data
->nfs_server
.address
,
997 data
->nfs_server
.addrlen
,
998 data
->client_address
,
999 data
->auth_flavors
[0],
1000 data
->nfs_server
.protocol
,
1005 /* Initialise the client representation from the mount data */
1006 server
->flags
= data
->flags
& NFS_MOUNT_FLAGMASK
;
1007 server
->caps
|= NFS_CAP_ATOMIC_OPEN
;
1010 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
1012 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
1014 server
->acregmin
= data
->acregmin
* HZ
;
1015 server
->acregmax
= data
->acregmax
* HZ
;
1016 server
->acdirmin
= data
->acdirmin
* HZ
;
1017 server
->acdirmax
= data
->acdirmax
* HZ
;
1019 error
= nfs_init_server_rpcclient(server
, &timeparms
, data
->auth_flavors
[0]);
1023 dprintk("<-- nfs4_init_server() = %d\n", error
);
1028 * Create a version 4 volume record
1029 * - keyed on server and FSID
1031 struct nfs_server
*nfs4_create_server(const struct nfs_parsed_mount_data
*data
,
1032 struct nfs_fh
*mntfh
)
1034 struct nfs_fattr fattr
;
1035 struct nfs_server
*server
;
1038 dprintk("--> nfs4_create_server()\n");
1040 server
= nfs_alloc_server();
1042 return ERR_PTR(-ENOMEM
);
1044 /* set up the general RPC client */
1045 error
= nfs4_init_server(server
, data
);
1049 BUG_ON(!server
->nfs_client
);
1050 BUG_ON(!server
->nfs_client
->rpc_ops
);
1051 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1053 /* Probe the root fh to retrieve its FSID */
1054 error
= nfs4_path_walk(server
, mntfh
, data
->nfs_server
.export_path
);
1058 dprintk("Server FSID: %llx:%llx\n",
1059 (unsigned long long) server
->fsid
.major
,
1060 (unsigned long long) server
->fsid
.minor
);
1061 dprintk("Mount FH: %d\n", mntfh
->size
);
1063 error
= nfs_probe_fsinfo(server
, mntfh
, &fattr
);
1067 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1068 server
->namelen
= NFS4_MAXNAMLEN
;
1070 BUG_ON(!server
->nfs_client
);
1071 BUG_ON(!server
->nfs_client
->rpc_ops
);
1072 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1074 spin_lock(&nfs_client_lock
);
1075 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
1076 list_add_tail(&server
->master_link
, &nfs_volume_list
);
1077 spin_unlock(&nfs_client_lock
);
1079 server
->mount_time
= jiffies
;
1080 dprintk("<-- nfs4_create_server() = %p\n", server
);
1084 nfs_free_server(server
);
1085 dprintk("<-- nfs4_create_server() = error %d\n", error
);
1086 return ERR_PTR(error
);
1090 * Create an NFS4 referral server record
1092 struct nfs_server
*nfs4_create_referral_server(struct nfs_clone_mount
*data
,
1093 struct nfs_fh
*mntfh
)
1095 struct nfs_client
*parent_client
;
1096 struct nfs_server
*server
, *parent_server
;
1097 struct nfs_fattr fattr
;
1100 dprintk("--> nfs4_create_referral_server()\n");
1102 server
= nfs_alloc_server();
1104 return ERR_PTR(-ENOMEM
);
1106 parent_server
= NFS_SB(data
->sb
);
1107 parent_client
= parent_server
->nfs_client
;
1109 /* Get a client representation.
1110 * Note: NFSv4 always uses TCP, */
1111 error
= nfs4_set_client(server
, data
->hostname
,
1114 parent_client
->cl_ipaddr
,
1116 parent_server
->client
->cl_xprt
->prot
,
1117 parent_server
->client
->cl_timeout
);
1121 /* Initialise the client representation from the parent server */
1122 nfs_server_copy_userdata(server
, parent_server
);
1123 server
->caps
|= NFS_CAP_ATOMIC_OPEN
;
1125 error
= nfs_init_server_rpcclient(server
, parent_server
->client
->cl_timeout
, data
->authflavor
);
1129 BUG_ON(!server
->nfs_client
);
1130 BUG_ON(!server
->nfs_client
->rpc_ops
);
1131 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1133 /* Probe the root fh to retrieve its FSID and filehandle */
1134 error
= nfs4_path_walk(server
, mntfh
, data
->mnt_path
);
1138 /* probe the filesystem info for this server filesystem */
1139 error
= nfs_probe_fsinfo(server
, mntfh
, &fattr
);
1143 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1144 server
->namelen
= NFS4_MAXNAMLEN
;
1146 dprintk("Referral FSID: %llx:%llx\n",
1147 (unsigned long long) server
->fsid
.major
,
1148 (unsigned long long) server
->fsid
.minor
);
1150 spin_lock(&nfs_client_lock
);
1151 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
1152 list_add_tail(&server
->master_link
, &nfs_volume_list
);
1153 spin_unlock(&nfs_client_lock
);
1155 server
->mount_time
= jiffies
;
1157 dprintk("<-- nfs_create_referral_server() = %p\n", server
);
1161 nfs_free_server(server
);
1162 dprintk("<-- nfs4_create_referral_server() = error %d\n", error
);
1163 return ERR_PTR(error
);
1166 #endif /* CONFIG_NFS_V4 */
1169 * Clone an NFS2, NFS3 or NFS4 server record
1171 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
1173 struct nfs_fattr
*fattr
)
1175 struct nfs_server
*server
;
1176 struct nfs_fattr fattr_fsinfo
;
1179 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1180 (unsigned long long) fattr
->fsid
.major
,
1181 (unsigned long long) fattr
->fsid
.minor
);
1183 server
= nfs_alloc_server();
1185 return ERR_PTR(-ENOMEM
);
1187 /* Copy data from the source */
1188 server
->nfs_client
= source
->nfs_client
;
1189 atomic_inc(&server
->nfs_client
->cl_count
);
1190 nfs_server_copy_userdata(server
, source
);
1192 server
->fsid
= fattr
->fsid
;
1194 error
= nfs_init_server_rpcclient(server
,
1195 source
->client
->cl_timeout
,
1196 source
->client
->cl_auth
->au_flavor
);
1198 goto out_free_server
;
1199 if (!IS_ERR(source
->client_acl
))
1200 nfs_init_server_aclclient(server
);
1202 /* probe the filesystem info for this server filesystem */
1203 error
= nfs_probe_fsinfo(server
, fh
, &fattr_fsinfo
);
1205 goto out_free_server
;
1207 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1208 server
->namelen
= NFS4_MAXNAMLEN
;
1210 dprintk("Cloned FSID: %llx:%llx\n",
1211 (unsigned long long) server
->fsid
.major
,
1212 (unsigned long long) server
->fsid
.minor
);
1214 error
= nfs_start_lockd(server
);
1216 goto out_free_server
;
1218 spin_lock(&nfs_client_lock
);
1219 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
1220 list_add_tail(&server
->master_link
, &nfs_volume_list
);
1221 spin_unlock(&nfs_client_lock
);
1223 server
->mount_time
= jiffies
;
1225 dprintk("<-- nfs_clone_server() = %p\n", server
);
1229 nfs_free_server(server
);
1230 dprintk("<-- nfs_clone_server() = error %d\n", error
);
1231 return ERR_PTR(error
);
1234 #ifdef CONFIG_PROC_FS
1235 static struct proc_dir_entry
*proc_fs_nfs
;
1237 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
);
1238 static void *nfs_server_list_start(struct seq_file
*p
, loff_t
*pos
);
1239 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1240 static void nfs_server_list_stop(struct seq_file
*p
, void *v
);
1241 static int nfs_server_list_show(struct seq_file
*m
, void *v
);
1243 static struct seq_operations nfs_server_list_ops
= {
1244 .start
= nfs_server_list_start
,
1245 .next
= nfs_server_list_next
,
1246 .stop
= nfs_server_list_stop
,
1247 .show
= nfs_server_list_show
,
1250 static const struct file_operations nfs_server_list_fops
= {
1251 .open
= nfs_server_list_open
,
1253 .llseek
= seq_lseek
,
1254 .release
= seq_release
,
1257 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
);
1258 static void *nfs_volume_list_start(struct seq_file
*p
, loff_t
*pos
);
1259 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1260 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
);
1261 static int nfs_volume_list_show(struct seq_file
*m
, void *v
);
1263 static struct seq_operations nfs_volume_list_ops
= {
1264 .start
= nfs_volume_list_start
,
1265 .next
= nfs_volume_list_next
,
1266 .stop
= nfs_volume_list_stop
,
1267 .show
= nfs_volume_list_show
,
1270 static const struct file_operations nfs_volume_list_fops
= {
1271 .open
= nfs_volume_list_open
,
1273 .llseek
= seq_lseek
,
1274 .release
= seq_release
,
1278 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1281 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
)
1286 ret
= seq_open(file
, &nfs_server_list_ops
);
1290 m
= file
->private_data
;
1291 m
->private = PDE(inode
)->data
;
1297 * set up the iterator to start reading from the server list and return the first item
1299 static void *nfs_server_list_start(struct seq_file
*m
, loff_t
*_pos
)
1301 /* lock the list against modification */
1302 spin_lock(&nfs_client_lock
);
1303 return seq_list_start_head(&nfs_client_list
, *_pos
);
1307 * move to next server
1309 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1311 return seq_list_next(v
, &nfs_client_list
, pos
);
1315 * clean up after reading from the transports list
1317 static void nfs_server_list_stop(struct seq_file
*p
, void *v
)
1319 spin_unlock(&nfs_client_lock
);
1323 * display a header line followed by a load of call lines
1325 static int nfs_server_list_show(struct seq_file
*m
, void *v
)
1327 struct nfs_client
*clp
;
1329 /* display header on line 1 */
1330 if (v
== &nfs_client_list
) {
1331 seq_puts(m
, "NV SERVER PORT USE HOSTNAME\n");
1335 /* display one transport per line on subsequent lines */
1336 clp
= list_entry(v
, struct nfs_client
, cl_share_link
);
1338 seq_printf(m
, "v%u %s %s %3d %s\n",
1339 clp
->rpc_ops
->version
,
1340 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1341 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1342 atomic_read(&clp
->cl_count
),
1349 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1351 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
)
1356 ret
= seq_open(file
, &nfs_volume_list_ops
);
1360 m
= file
->private_data
;
1361 m
->private = PDE(inode
)->data
;
1367 * set up the iterator to start reading from the volume list and return the first item
1369 static void *nfs_volume_list_start(struct seq_file
*m
, loff_t
*_pos
)
1371 /* lock the list against modification */
1372 spin_lock(&nfs_client_lock
);
1373 return seq_list_start_head(&nfs_volume_list
, *_pos
);
1377 * move to next volume
1379 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1381 return seq_list_next(v
, &nfs_volume_list
, pos
);
1385 * clean up after reading from the transports list
1387 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
)
1389 spin_unlock(&nfs_client_lock
);
1393 * display a header line followed by a load of call lines
1395 static int nfs_volume_list_show(struct seq_file
*m
, void *v
)
1397 struct nfs_server
*server
;
1398 struct nfs_client
*clp
;
1399 char dev
[8], fsid
[17];
1401 /* display header on line 1 */
1402 if (v
== &nfs_volume_list
) {
1403 seq_puts(m
, "NV SERVER PORT DEV FSID\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
);
1417 seq_printf(m
, "v%u %s %s %-7s %-17s\n",
1418 clp
->rpc_ops
->version
,
1419 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1420 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1428 * initialise the /proc/fs/nfsfs/ directory
1430 int __init
nfs_fs_proc_init(void)
1432 struct proc_dir_entry
*p
;
1434 proc_fs_nfs
= proc_mkdir("nfsfs", proc_root_fs
);
1438 proc_fs_nfs
->owner
= THIS_MODULE
;
1440 /* a file of servers with which we're dealing */
1441 p
= create_proc_entry("servers", S_IFREG
|S_IRUGO
, proc_fs_nfs
);
1445 p
->proc_fops
= &nfs_server_list_fops
;
1446 p
->owner
= THIS_MODULE
;
1448 /* a file of volumes that we have mounted */
1449 p
= create_proc_entry("volumes", S_IFREG
|S_IRUGO
, proc_fs_nfs
);
1453 p
->proc_fops
= &nfs_volume_list_fops
;
1454 p
->owner
= THIS_MODULE
;
1458 remove_proc_entry("servers", proc_fs_nfs
);
1460 remove_proc_entry("nfsfs", proc_root_fs
);
1466 * clean up the /proc/fs/nfsfs/ directory
1468 void nfs_fs_proc_exit(void)
1470 remove_proc_entry("volumes", proc_fs_nfs
);
1471 remove_proc_entry("servers", proc_fs_nfs
);
1472 remove_proc_entry("nfsfs", proc_root_fs
);
1475 #endif /* CONFIG_PROC_FS */