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/config.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
17 #include <linux/time.h>
18 #include <linux/kernel.h>
20 #include <linux/string.h>
21 #include <linux/stat.h>
22 #include <linux/errno.h>
23 #include <linux/unistd.h>
24 #include <linux/sunrpc/clnt.h>
25 #include <linux/sunrpc/stats.h>
26 #include <linux/sunrpc/metrics.h>
27 #include <linux/nfs_fs.h>
28 #include <linux/nfs_mount.h>
29 #include <linux/nfs4_mount.h>
30 #include <linux/lockd/bind.h>
31 #include <linux/smp_lock.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/nfs_xdr.h>
39 #include <asm/system.h>
43 #include "delegation.h"
47 #define NFSDBG_FACILITY NFSDBG_CLIENT
49 static DEFINE_SPINLOCK(nfs_client_lock
);
50 static LIST_HEAD(nfs_client_list
);
51 static LIST_HEAD(nfs_volume_list
);
52 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq
);
57 static struct rpc_version
*nfs_version
[5] = {
67 struct rpc_program nfs_program
= {
69 .number
= NFS_PROGRAM
,
70 .nrvers
= ARRAY_SIZE(nfs_version
),
71 .version
= nfs_version
,
72 .stats
= &nfs_rpcstat
,
73 .pipe_dir_name
= "/nfs",
76 struct rpc_stat nfs_rpcstat
= {
77 .program
= &nfs_program
81 #ifdef CONFIG_NFS_V3_ACL
82 static struct rpc_stat nfsacl_rpcstat
= { &nfsacl_program
};
83 static struct rpc_version
* nfsacl_version
[] = {
84 [3] = &nfsacl_version3
,
87 struct rpc_program nfsacl_program
= {
89 .number
= NFS_ACL_PROGRAM
,
90 .nrvers
= ARRAY_SIZE(nfsacl_version
),
91 .version
= nfsacl_version
,
92 .stats
= &nfsacl_rpcstat
,
94 #endif /* CONFIG_NFS_V3_ACL */
97 * Allocate a shared client record
99 * Since these are allocated/deallocated very rarely, we don't
100 * bother putting them in a slab cache...
102 static struct nfs_client
*nfs_alloc_client(const char *hostname
,
103 const struct sockaddr_in
*addr
,
106 struct nfs_client
*clp
;
109 if ((clp
= kzalloc(sizeof(*clp
), GFP_KERNEL
)) == NULL
)
114 dprintk("%s: couldn't start rpciod! Error = %d\n",
115 __FUNCTION__
, error
);
118 __set_bit(NFS_CS_RPCIOD
, &clp
->cl_res_state
);
120 if (nfsversion
== 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 clp
->cl_nfsversion
= nfsversion
;
130 memcpy(&clp
->cl_addr
, addr
, sizeof(clp
->cl_addr
));
133 clp
->cl_hostname
= kstrdup(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 INIT_LIST_HEAD(&clp
->cl_state_owners
);
145 INIT_LIST_HEAD(&clp
->cl_unused
);
146 spin_lock_init(&clp
->cl_lock
);
147 INIT_WORK(&clp
->cl_renewd
, nfs4_renew_state
, clp
);
148 rpc_init_wait_queue(&clp
->cl_rpcwaitq
, "NFS client");
149 clp
->cl_boot_time
= CURRENT_TIME
;
150 clp
->cl_state
= 1 << NFS4CLNT_LEASE_EXPIRED
;
156 if (__test_and_clear_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
))
160 __clear_bit(NFS_CS_RPCIOD
, &clp
->cl_res_state
);
167 static void nfs4_shutdown_client(struct nfs_client
*clp
)
170 if (__test_and_clear_bit(NFS_CS_RENEWD
, &clp
->cl_res_state
))
171 nfs4_kill_renewd(clp
);
172 while (!list_empty(&clp
->cl_unused
)) {
173 struct nfs4_state_owner
*sp
;
175 sp
= list_entry(clp
->cl_unused
.next
,
176 struct nfs4_state_owner
,
178 list_del(&sp
->so_list
);
181 BUG_ON(!list_empty(&clp
->cl_state_owners
));
182 if (__test_and_clear_bit(NFS_CS_IDMAP
, &clp
->cl_res_state
))
183 nfs_idmap_delete(clp
);
188 * Destroy a shared client record
190 static void nfs_free_client(struct nfs_client
*clp
)
192 dprintk("--> nfs_free_client(%d)\n", clp
->cl_nfsversion
);
194 nfs4_shutdown_client(clp
);
196 /* -EIO all pending I/O */
197 if (!IS_ERR(clp
->cl_rpcclient
))
198 rpc_shutdown_client(clp
->cl_rpcclient
);
200 if (__test_and_clear_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
))
203 if (__test_and_clear_bit(NFS_CS_RPCIOD
, &clp
->cl_res_state
))
206 kfree(clp
->cl_hostname
);
209 dprintk("<-- nfs_free_client()\n");
213 * Release a reference to a shared client record
215 void nfs_put_client(struct nfs_client
*clp
)
220 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp
->cl_count
));
222 if (atomic_dec_and_lock(&clp
->cl_count
, &nfs_client_lock
)) {
223 list_del(&clp
->cl_share_link
);
224 spin_unlock(&nfs_client_lock
);
226 BUG_ON(!list_empty(&clp
->cl_superblocks
));
228 nfs_free_client(clp
);
233 * Find a client by address
234 * - caller must hold nfs_client_lock
236 static struct nfs_client
*__nfs_find_client(const struct sockaddr_in
*addr
, int nfsversion
)
238 struct nfs_client
*clp
;
240 list_for_each_entry(clp
, &nfs_client_list
, cl_share_link
) {
241 /* Different NFS versions cannot share the same nfs_client */
242 if (clp
->cl_nfsversion
!= nfsversion
)
245 if (memcmp(&clp
->cl_addr
.sin_addr
, &addr
->sin_addr
,
246 sizeof(clp
->cl_addr
.sin_addr
)) != 0)
249 if (clp
->cl_addr
.sin_port
== addr
->sin_port
)
256 atomic_inc(&clp
->cl_count
);
261 * Find a client by IP address and protocol version
262 * - returns NULL if no such client
264 struct nfs_client
*nfs_find_client(const struct sockaddr_in
*addr
, int nfsversion
)
266 struct nfs_client
*clp
;
268 spin_lock(&nfs_client_lock
);
269 clp
= __nfs_find_client(addr
, nfsversion
);
270 spin_unlock(&nfs_client_lock
);
272 BUG_ON(clp
&& clp
->cl_cons_state
== 0);
278 * Look up a client by IP address and protocol version
279 * - creates a new record if one doesn't yet exist
281 static struct nfs_client
*nfs_get_client(const char *hostname
,
282 const struct sockaddr_in
*addr
,
285 struct nfs_client
*clp
, *new = NULL
;
288 dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT
":%d,%d)\n",
289 hostname
?: "", NIPQUAD(addr
->sin_addr
),
290 addr
->sin_port
, nfsversion
);
292 /* see if the client already exists */
294 spin_lock(&nfs_client_lock
);
296 clp
= __nfs_find_client(addr
, nfsversion
);
302 spin_unlock(&nfs_client_lock
);
304 new = nfs_alloc_client(hostname
, addr
, nfsversion
);
307 return ERR_PTR(-ENOMEM
);
309 /* install a new client and return with it unready */
312 list_add(&clp
->cl_share_link
, &nfs_client_list
);
313 spin_unlock(&nfs_client_lock
);
314 dprintk("--> nfs_get_client() = %p [new]\n", clp
);
317 /* found an existing client
318 * - make sure it's ready before returning
321 spin_unlock(&nfs_client_lock
);
324 nfs_free_client(new);
326 if (clp
->cl_cons_state
== NFS_CS_INITING
) {
327 DECLARE_WAITQUEUE(myself
, current
);
329 add_wait_queue(&nfs_client_active_wq
, &myself
);
332 set_current_state(TASK_INTERRUPTIBLE
);
333 if (signal_pending(current
) ||
334 clp
->cl_cons_state
> NFS_CS_READY
)
339 remove_wait_queue(&nfs_client_active_wq
, &myself
);
341 if (signal_pending(current
)) {
343 return ERR_PTR(-ERESTARTSYS
);
347 if (clp
->cl_cons_state
< NFS_CS_READY
) {
348 error
= clp
->cl_cons_state
;
350 return ERR_PTR(error
);
353 BUG_ON(clp
->cl_cons_state
!= NFS_CS_READY
);
355 dprintk("--> nfs_get_client() = %p [share]\n", clp
);
360 * Mark a server as ready or failed
362 static void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
364 clp
->cl_cons_state
= state
;
365 wake_up_all(&nfs_client_active_wq
);
369 * Initialise the timeout values for a connection
371 static void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
372 unsigned int timeo
, unsigned int retrans
)
374 to
->to_initval
= timeo
* HZ
/ 10;
375 to
->to_retries
= retrans
;
382 to
->to_initval
= 60 * HZ
;
383 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
384 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
385 to
->to_increment
= to
->to_initval
;
386 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
387 to
->to_exponential
= 0;
392 to
->to_initval
= 11 * HZ
/ 10;
393 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
394 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
395 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
396 to
->to_exponential
= 1;
402 * Create an RPC client handle
404 static int nfs_create_rpc_client(struct nfs_client
*clp
, int proto
,
406 unsigned int retrans
,
407 rpc_authflavor_t flavor
)
409 struct rpc_timeout timeparms
;
410 struct rpc_clnt
*clnt
= NULL
;
411 struct rpc_create_args args
= {
413 .address
= (struct sockaddr
*)&clp
->cl_addr
,
414 .addrsize
= sizeof(clp
->cl_addr
),
415 .timeout
= &timeparms
,
416 .servername
= clp
->cl_hostname
,
417 .program
= &nfs_program
,
418 .version
= clp
->rpc_ops
->version
,
419 .authflavor
= flavor
,
422 if (!IS_ERR(clp
->cl_rpcclient
))
425 nfs_init_timeout_values(&timeparms
, proto
, timeo
, retrans
);
426 clp
->retrans_timeo
= timeparms
.to_initval
;
427 clp
->retrans_count
= timeparms
.to_retries
;
429 clnt
= rpc_create(&args
);
431 dprintk("%s: cannot create RPC client. Error = %ld\n",
432 __FUNCTION__
, PTR_ERR(clnt
));
433 return PTR_ERR(clnt
);
436 clp
->cl_rpcclient
= clnt
;
441 * Version 2 or 3 client destruction
443 static void nfs_destroy_server(struct nfs_server
*server
)
445 if (!IS_ERR(server
->client_acl
))
446 rpc_shutdown_client(server
->client_acl
);
448 if (!(server
->flags
& NFS_MOUNT_NONLM
))
449 lockd_down(); /* release rpc.lockd */
453 * Version 2 or 3 lockd setup
455 static int nfs_start_lockd(struct nfs_server
*server
)
459 if (server
->nfs_client
->cl_nfsversion
> 3)
461 if (server
->flags
& NFS_MOUNT_NONLM
)
465 server
->flags
|= NFS_MOUNT_NONLM
;
467 server
->destroy
= nfs_destroy_server
;
473 * Initialise an NFSv3 ACL client connection
475 #ifdef CONFIG_NFS_V3_ACL
476 static void nfs_init_server_aclclient(struct nfs_server
*server
)
478 if (server
->nfs_client
->cl_nfsversion
!= 3)
480 if (server
->flags
& NFS_MOUNT_NOACL
)
483 server
->client_acl
= rpc_bind_new_program(server
->client
, &nfsacl_program
, 3);
484 if (IS_ERR(server
->client_acl
))
487 /* No errors! Assume that Sun nfsacls are supported */
488 server
->caps
|= NFS_CAP_ACLS
;
492 server
->caps
&= ~NFS_CAP_ACLS
;
495 static inline void nfs_init_server_aclclient(struct nfs_server
*server
)
497 server
->flags
&= ~NFS_MOUNT_NOACL
;
498 server
->caps
&= ~NFS_CAP_ACLS
;
503 * Create a general RPC client
505 static int nfs_init_server_rpcclient(struct nfs_server
*server
, rpc_authflavor_t pseudoflavour
)
507 struct nfs_client
*clp
= server
->nfs_client
;
509 server
->client
= rpc_clone_client(clp
->cl_rpcclient
);
510 if (IS_ERR(server
->client
)) {
511 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__
);
512 return PTR_ERR(server
->client
);
515 if (pseudoflavour
!= clp
->cl_rpcclient
->cl_auth
->au_flavor
) {
516 struct rpc_auth
*auth
;
518 auth
= rpcauth_create(pseudoflavour
, server
->client
);
520 dprintk("%s: couldn't create credcache!\n", __FUNCTION__
);
521 return PTR_ERR(auth
);
524 server
->client
->cl_softrtry
= 0;
525 if (server
->flags
& NFS_MOUNT_SOFT
)
526 server
->client
->cl_softrtry
= 1;
528 server
->client
->cl_intr
= 0;
529 if (server
->flags
& NFS4_MOUNT_INTR
)
530 server
->client
->cl_intr
= 1;
536 * Initialise an NFS2 or NFS3 client
538 static int nfs_init_client(struct nfs_client
*clp
, const struct nfs_mount_data
*data
)
540 int proto
= (data
->flags
& NFS_MOUNT_TCP
) ? IPPROTO_TCP
: IPPROTO_UDP
;
543 if (clp
->cl_cons_state
== NFS_CS_READY
) {
544 /* the client is already initialised */
545 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp
);
549 /* Check NFS protocol revision and initialize RPC op vector */
550 clp
->rpc_ops
= &nfs_v2_clientops
;
552 if (clp
->cl_nfsversion
== 3)
553 clp
->rpc_ops
= &nfs_v3_clientops
;
556 * Create a client RPC handle for doing FSSTAT with UNIX auth only
557 * - RFC 2623, sec 2.3.2
559 error
= nfs_create_rpc_client(clp
, proto
, data
->timeo
, data
->retrans
,
563 nfs_mark_client_ready(clp
, NFS_CS_READY
);
567 nfs_mark_client_ready(clp
, error
);
568 dprintk("<-- nfs_init_client() = xerror %d\n", error
);
573 * Create a version 2 or 3 client
575 static int nfs_init_server(struct nfs_server
*server
, const struct nfs_mount_data
*data
)
577 struct nfs_client
*clp
;
578 int error
, nfsvers
= 2;
580 dprintk("--> nfs_init_server()\n");
583 if (data
->flags
& NFS_MOUNT_VER3
)
587 /* Allocate or find a client reference we can use */
588 clp
= nfs_get_client(data
->hostname
, &data
->addr
, nfsvers
);
590 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp
));
594 error
= nfs_init_client(clp
, data
);
598 server
->nfs_client
= clp
;
600 /* Initialise the client representation from the mount data */
601 server
->flags
= data
->flags
& NFS_MOUNT_FLAGMASK
;
604 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
606 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
608 server
->acregmin
= data
->acregmin
* HZ
;
609 server
->acregmax
= data
->acregmax
* HZ
;
610 server
->acdirmin
= data
->acdirmin
* HZ
;
611 server
->acdirmax
= data
->acdirmax
* HZ
;
613 /* Start lockd here, before we might error out */
614 error
= nfs_start_lockd(server
);
618 error
= nfs_init_server_rpcclient(server
, data
->pseudoflavor
);
622 server
->namelen
= data
->namlen
;
623 /* Create a client RPC handle for the NFSv3 ACL management interface */
624 nfs_init_server_aclclient(server
);
625 if (clp
->cl_nfsversion
== 3) {
626 if (server
->namelen
== 0 || server
->namelen
> NFS3_MAXNAMLEN
)
627 server
->namelen
= NFS3_MAXNAMLEN
;
628 server
->caps
|= NFS_CAP_READDIRPLUS
;
630 if (server
->namelen
== 0 || server
->namelen
> NFS2_MAXNAMLEN
)
631 server
->namelen
= NFS2_MAXNAMLEN
;
634 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp
);
638 server
->nfs_client
= NULL
;
640 dprintk("<-- nfs_init_server() = xerror %d\n", error
);
645 * Load up the server record from information gained in an fsinfo record
647 static void nfs_server_set_fsinfo(struct nfs_server
*server
, struct nfs_fsinfo
*fsinfo
)
649 unsigned long max_rpc_payload
;
651 /* Work out a lot of parameters */
652 if (server
->rsize
== 0)
653 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
654 if (server
->wsize
== 0)
655 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
657 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
658 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
659 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
660 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
662 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
663 if (server
->rsize
> max_rpc_payload
)
664 server
->rsize
= max_rpc_payload
;
665 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
666 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
667 server
->rpages
= (server
->rsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
668 server
->backing_dev_info
.ra_pages
= server
->rpages
* NFS_MAX_READAHEAD
;
670 if (server
->wsize
> max_rpc_payload
)
671 server
->wsize
= max_rpc_payload
;
672 if (server
->wsize
> NFS_MAX_FILE_IO_SIZE
)
673 server
->wsize
= NFS_MAX_FILE_IO_SIZE
;
674 server
->wpages
= (server
->wsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
675 server
->wtmult
= nfs_block_bits(fsinfo
->wtmult
, NULL
);
677 server
->dtsize
= nfs_block_size(fsinfo
->dtpref
, NULL
);
678 if (server
->dtsize
> PAGE_CACHE_SIZE
)
679 server
->dtsize
= PAGE_CACHE_SIZE
;
680 if (server
->dtsize
> server
->rsize
)
681 server
->dtsize
= server
->rsize
;
683 if (server
->flags
& NFS_MOUNT_NOAC
) {
684 server
->acregmin
= server
->acregmax
= 0;
685 server
->acdirmin
= server
->acdirmax
= 0;
688 server
->maxfilesize
= fsinfo
->maxfilesize
;
690 /* We're airborne Set socket buffersize */
691 rpc_setbufsize(server
->client
, server
->wsize
+ 100, server
->rsize
+ 100);
695 * Probe filesystem information, including the FSID on v2/v3
697 static int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*mntfh
, struct nfs_fattr
*fattr
)
699 struct nfs_fsinfo fsinfo
;
700 struct nfs_client
*clp
= server
->nfs_client
;
703 dprintk("--> nfs_probe_fsinfo()\n");
705 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
706 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
711 fsinfo
.fattr
= fattr
;
712 nfs_fattr_init(fattr
);
713 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
717 nfs_server_set_fsinfo(server
, &fsinfo
);
719 /* Get some general file system info */
720 if (server
->namelen
== 0) {
721 struct nfs_pathconf pathinfo
;
723 pathinfo
.fattr
= fattr
;
724 nfs_fattr_init(fattr
);
726 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
727 server
->namelen
= pathinfo
.max_namelen
;
730 dprintk("<-- nfs_probe_fsinfo() = 0\n");
734 dprintk("nfs_probe_fsinfo: error = %d\n", -error
);
739 * Copy useful information when duplicating a server record
741 static void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
743 target
->flags
= source
->flags
;
744 target
->acregmin
= source
->acregmin
;
745 target
->acregmax
= source
->acregmax
;
746 target
->acdirmin
= source
->acdirmin
;
747 target
->acdirmax
= source
->acdirmax
;
748 target
->caps
= source
->caps
;
752 * Allocate and initialise a server record
754 static struct nfs_server
*nfs_alloc_server(void)
756 struct nfs_server
*server
;
758 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
762 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
764 /* Zero out the NFS state stuff */
765 INIT_LIST_HEAD(&server
->client_link
);
766 INIT_LIST_HEAD(&server
->master_link
);
768 server
->io_stats
= nfs_alloc_iostats();
769 if (!server
->io_stats
) {
778 * Free up a server record
780 void nfs_free_server(struct nfs_server
*server
)
782 dprintk("--> nfs_free_server()\n");
784 spin_lock(&nfs_client_lock
);
785 list_del(&server
->client_link
);
786 list_del(&server
->master_link
);
787 spin_unlock(&nfs_client_lock
);
789 if (server
->destroy
!= NULL
)
790 server
->destroy(server
);
791 if (!IS_ERR(server
->client
))
792 rpc_shutdown_client(server
->client
);
794 nfs_put_client(server
->nfs_client
);
796 nfs_free_iostats(server
->io_stats
);
798 nfs_release_automount_timer();
799 dprintk("<-- nfs_free_server()\n");
803 * Create a version 2 or 3 volume record
804 * - keyed on server and FSID
806 struct nfs_server
*nfs_create_server(const struct nfs_mount_data
*data
,
807 struct nfs_fh
*mntfh
)
809 struct nfs_server
*server
;
810 struct nfs_fattr fattr
;
813 server
= nfs_alloc_server();
815 return ERR_PTR(-ENOMEM
);
817 /* Get a client representation */
818 error
= nfs_init_server(server
, data
);
822 BUG_ON(!server
->nfs_client
);
823 BUG_ON(!server
->nfs_client
->rpc_ops
);
824 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
826 /* Probe the root fh to retrieve its FSID */
827 error
= nfs_probe_fsinfo(server
, mntfh
, &fattr
);
830 if (!(fattr
.valid
& NFS_ATTR_FATTR
)) {
831 error
= server
->nfs_client
->rpc_ops
->getattr(server
, mntfh
, &fattr
);
833 dprintk("nfs_create_server: getattr error = %d\n", -error
);
837 memcpy(&server
->fsid
, &fattr
.fsid
, sizeof(server
->fsid
));
839 dprintk("Server FSID: %llx:%llx\n",
840 (unsigned long long) server
->fsid
.major
,
841 (unsigned long long) server
->fsid
.minor
);
843 BUG_ON(!server
->nfs_client
);
844 BUG_ON(!server
->nfs_client
->rpc_ops
);
845 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
847 spin_lock(&nfs_client_lock
);
848 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
849 list_add_tail(&server
->master_link
, &nfs_volume_list
);
850 spin_unlock(&nfs_client_lock
);
852 server
->mount_time
= jiffies
;
856 nfs_free_server(server
);
857 return ERR_PTR(error
);
862 * Initialise an NFS4 client record
864 static int nfs4_init_client(struct nfs_client
*clp
,
865 int proto
, int timeo
, int retrans
,
866 rpc_authflavor_t authflavour
)
870 if (clp
->cl_cons_state
== NFS_CS_READY
) {
871 /* the client is initialised already */
872 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp
);
876 /* Check NFS protocol revision and initialize RPC op vector */
877 clp
->rpc_ops
= &nfs_v4_clientops
;
879 error
= nfs_create_rpc_client(clp
, proto
, timeo
, retrans
, authflavour
);
883 error
= nfs_idmap_new(clp
);
885 dprintk("%s: failed to create idmapper. Error = %d\n",
886 __FUNCTION__
, error
);
889 __set_bit(NFS_CS_IDMAP
, &clp
->cl_res_state
);
891 nfs_mark_client_ready(clp
, NFS_CS_READY
);
895 nfs_mark_client_ready(clp
, error
);
896 dprintk("<-- nfs4_init_client() = xerror %d\n", error
);
901 * Set up an NFS4 client
903 static int nfs4_set_client(struct nfs_server
*server
,
904 const char *hostname
, const struct sockaddr_in
*addr
,
905 rpc_authflavor_t authflavour
,
906 int proto
, int timeo
, int retrans
)
908 struct nfs_client
*clp
;
911 dprintk("--> nfs4_set_client()\n");
913 /* Allocate or find a client reference we can use */
914 clp
= nfs_get_client(hostname
, addr
, 4);
916 error
= PTR_ERR(clp
);
919 error
= nfs4_init_client(clp
, proto
, timeo
, retrans
, authflavour
);
923 server
->nfs_client
= clp
;
924 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp
);
930 dprintk("<-- nfs4_set_client() = xerror %d\n", error
);
935 * Create a version 4 volume record
937 static int nfs4_init_server(struct nfs_server
*server
,
938 const struct nfs4_mount_data
*data
, rpc_authflavor_t authflavour
)
942 dprintk("--> nfs4_init_server()\n");
944 /* Initialise the client representation from the mount data */
945 server
->flags
= data
->flags
& NFS_MOUNT_FLAGMASK
;
946 server
->caps
|= NFS_CAP_ATOMIC_OPEN
;
949 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
951 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
953 server
->acregmin
= data
->acregmin
* HZ
;
954 server
->acregmax
= data
->acregmax
* HZ
;
955 server
->acdirmin
= data
->acdirmin
* HZ
;
956 server
->acdirmax
= data
->acdirmax
* HZ
;
958 error
= nfs_init_server_rpcclient(server
, authflavour
);
961 dprintk("<-- nfs4_init_server() = %d\n", error
);
966 * Create a version 4 volume record
967 * - keyed on server and FSID
969 struct nfs_server
*nfs4_create_server(const struct nfs4_mount_data
*data
,
970 const char *hostname
,
971 const struct sockaddr_in
*addr
,
974 rpc_authflavor_t authflavour
,
975 struct nfs_fh
*mntfh
)
977 struct nfs_fattr fattr
;
978 struct nfs_server
*server
;
981 dprintk("--> nfs4_create_server()\n");
983 server
= nfs_alloc_server();
985 return ERR_PTR(-ENOMEM
);
987 /* Get a client record */
988 error
= nfs4_set_client(server
, hostname
, addr
, authflavour
,
989 data
->proto
, data
->timeo
, data
->retrans
);
993 /* set up the general RPC client */
994 error
= nfs4_init_server(server
, data
, authflavour
);
998 BUG_ON(!server
->nfs_client
);
999 BUG_ON(!server
->nfs_client
->rpc_ops
);
1000 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1002 /* Probe the root fh to retrieve its FSID */
1003 error
= nfs4_path_walk(server
, mntfh
, mntpath
);
1007 dprintk("Server FSID: %llx:%llx\n",
1008 (unsigned long long) server
->fsid
.major
,
1009 (unsigned long long) server
->fsid
.minor
);
1010 dprintk("Mount FH: %d\n", mntfh
->size
);
1012 error
= nfs_probe_fsinfo(server
, mntfh
, &fattr
);
1016 BUG_ON(!server
->nfs_client
);
1017 BUG_ON(!server
->nfs_client
->rpc_ops
);
1018 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1020 spin_lock(&nfs_client_lock
);
1021 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
1022 list_add_tail(&server
->master_link
, &nfs_volume_list
);
1023 spin_unlock(&nfs_client_lock
);
1025 server
->mount_time
= jiffies
;
1026 dprintk("<-- nfs4_create_server() = %p\n", server
);
1030 nfs_free_server(server
);
1031 dprintk("<-- nfs4_create_server() = error %d\n", error
);
1032 return ERR_PTR(error
);
1036 * Create an NFS4 referral server record
1038 struct nfs_server
*nfs4_create_referral_server(struct nfs_clone_mount
*data
,
1041 struct nfs_client
*parent_client
;
1042 struct nfs_server
*server
, *parent_server
;
1043 struct nfs_fattr fattr
;
1046 dprintk("--> nfs4_create_referral_server()\n");
1048 server
= nfs_alloc_server();
1050 return ERR_PTR(-ENOMEM
);
1052 parent_server
= NFS_SB(data
->sb
);
1053 parent_client
= parent_server
->nfs_client
;
1055 /* Get a client representation.
1056 * Note: NFSv4 always uses TCP, */
1057 error
= nfs4_set_client(server
, data
->hostname
, data
->addr
,
1059 parent_server
->client
->cl_xprt
->prot
,
1060 parent_client
->retrans_timeo
,
1061 parent_client
->retrans_count
);
1065 /* Initialise the client representation from the parent server */
1066 nfs_server_copy_userdata(server
, parent_server
);
1067 server
->caps
|= NFS_CAP_ATOMIC_OPEN
;
1069 error
= nfs_init_server_rpcclient(server
, data
->authflavor
);
1073 BUG_ON(!server
->nfs_client
);
1074 BUG_ON(!server
->nfs_client
->rpc_ops
);
1075 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1077 /* probe the filesystem info for this server filesystem */
1078 error
= nfs_probe_fsinfo(server
, fh
, &fattr
);
1082 dprintk("Referral FSID: %llx:%llx\n",
1083 (unsigned long long) server
->fsid
.major
,
1084 (unsigned long long) server
->fsid
.minor
);
1086 spin_lock(&nfs_client_lock
);
1087 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
1088 list_add_tail(&server
->master_link
, &nfs_volume_list
);
1089 spin_unlock(&nfs_client_lock
);
1091 server
->mount_time
= jiffies
;
1093 dprintk("<-- nfs_create_referral_server() = %p\n", server
);
1097 nfs_free_server(server
);
1098 dprintk("<-- nfs4_create_referral_server() = error %d\n", error
);
1099 return ERR_PTR(error
);
1102 #endif /* CONFIG_NFS_V4 */
1105 * Clone an NFS2, NFS3 or NFS4 server record
1107 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
1109 struct nfs_fattr
*fattr
)
1111 struct nfs_server
*server
;
1112 struct nfs_fattr fattr_fsinfo
;
1115 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1116 (unsigned long long) fattr
->fsid
.major
,
1117 (unsigned long long) fattr
->fsid
.minor
);
1119 server
= nfs_alloc_server();
1121 return ERR_PTR(-ENOMEM
);
1123 /* Copy data from the source */
1124 server
->nfs_client
= source
->nfs_client
;
1125 atomic_inc(&server
->nfs_client
->cl_count
);
1126 nfs_server_copy_userdata(server
, source
);
1128 server
->fsid
= fattr
->fsid
;
1130 error
= nfs_init_server_rpcclient(server
, source
->client
->cl_auth
->au_flavor
);
1132 goto out_free_server
;
1133 if (!IS_ERR(source
->client_acl
))
1134 nfs_init_server_aclclient(server
);
1136 /* probe the filesystem info for this server filesystem */
1137 error
= nfs_probe_fsinfo(server
, fh
, &fattr_fsinfo
);
1139 goto out_free_server
;
1141 dprintk("Cloned FSID: %llx:%llx\n",
1142 (unsigned long long) server
->fsid
.major
,
1143 (unsigned long long) server
->fsid
.minor
);
1145 error
= nfs_start_lockd(server
);
1147 goto out_free_server
;
1149 spin_lock(&nfs_client_lock
);
1150 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
1151 list_add_tail(&server
->master_link
, &nfs_volume_list
);
1152 spin_unlock(&nfs_client_lock
);
1154 server
->mount_time
= jiffies
;
1156 dprintk("<-- nfs_clone_server() = %p\n", server
);
1160 nfs_free_server(server
);
1161 dprintk("<-- nfs_clone_server() = error %d\n", error
);
1162 return ERR_PTR(error
);
1165 #ifdef CONFIG_PROC_FS
1166 static struct proc_dir_entry
*proc_fs_nfs
;
1168 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
);
1169 static void *nfs_server_list_start(struct seq_file
*p
, loff_t
*pos
);
1170 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1171 static void nfs_server_list_stop(struct seq_file
*p
, void *v
);
1172 static int nfs_server_list_show(struct seq_file
*m
, void *v
);
1174 static struct seq_operations nfs_server_list_ops
= {
1175 .start
= nfs_server_list_start
,
1176 .next
= nfs_server_list_next
,
1177 .stop
= nfs_server_list_stop
,
1178 .show
= nfs_server_list_show
,
1181 static struct file_operations nfs_server_list_fops
= {
1182 .open
= nfs_server_list_open
,
1184 .llseek
= seq_lseek
,
1185 .release
= seq_release
,
1188 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
);
1189 static void *nfs_volume_list_start(struct seq_file
*p
, loff_t
*pos
);
1190 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1191 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
);
1192 static int nfs_volume_list_show(struct seq_file
*m
, void *v
);
1194 static struct seq_operations nfs_volume_list_ops
= {
1195 .start
= nfs_volume_list_start
,
1196 .next
= nfs_volume_list_next
,
1197 .stop
= nfs_volume_list_stop
,
1198 .show
= nfs_volume_list_show
,
1201 static struct file_operations nfs_volume_list_fops
= {
1202 .open
= nfs_volume_list_open
,
1204 .llseek
= seq_lseek
,
1205 .release
= seq_release
,
1209 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1212 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
)
1217 ret
= seq_open(file
, &nfs_server_list_ops
);
1221 m
= file
->private_data
;
1222 m
->private = PDE(inode
)->data
;
1228 * set up the iterator to start reading from the server list and return the first item
1230 static void *nfs_server_list_start(struct seq_file
*m
, loff_t
*_pos
)
1232 struct list_head
*_p
;
1235 /* lock the list against modification */
1236 spin_lock(&nfs_client_lock
);
1238 /* allow for the header line */
1240 return SEQ_START_TOKEN
;
1243 /* find the n'th element in the list */
1244 list_for_each(_p
, &nfs_client_list
)
1248 return _p
!= &nfs_client_list
? _p
: NULL
;
1252 * move to next server
1254 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1256 struct list_head
*_p
;
1261 _p
= (v
== SEQ_START_TOKEN
) ? nfs_client_list
.next
: _p
->next
;
1263 return _p
!= &nfs_client_list
? _p
: NULL
;
1267 * clean up after reading from the transports list
1269 static void nfs_server_list_stop(struct seq_file
*p
, void *v
)
1271 spin_unlock(&nfs_client_lock
);
1275 * display a header line followed by a load of call lines
1277 static int nfs_server_list_show(struct seq_file
*m
, void *v
)
1279 struct nfs_client
*clp
;
1281 /* display header on line 1 */
1282 if (v
== SEQ_START_TOKEN
) {
1283 seq_puts(m
, "NV SERVER PORT USE HOSTNAME\n");
1287 /* display one transport per line on subsequent lines */
1288 clp
= list_entry(v
, struct nfs_client
, cl_share_link
);
1290 seq_printf(m
, "v%d %02x%02x%02x%02x %4hx %3d %s\n",
1292 NIPQUAD(clp
->cl_addr
.sin_addr
),
1293 ntohs(clp
->cl_addr
.sin_port
),
1294 atomic_read(&clp
->cl_count
),
1301 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1303 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
)
1308 ret
= seq_open(file
, &nfs_volume_list_ops
);
1312 m
= file
->private_data
;
1313 m
->private = PDE(inode
)->data
;
1319 * set up the iterator to start reading from the volume list and return the first item
1321 static void *nfs_volume_list_start(struct seq_file
*m
, loff_t
*_pos
)
1323 struct list_head
*_p
;
1326 /* lock the list against modification */
1327 spin_lock(&nfs_client_lock
);
1329 /* allow for the header line */
1331 return SEQ_START_TOKEN
;
1334 /* find the n'th element in the list */
1335 list_for_each(_p
, &nfs_volume_list
)
1339 return _p
!= &nfs_volume_list
? _p
: NULL
;
1343 * move to next volume
1345 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1347 struct list_head
*_p
;
1352 _p
= (v
== SEQ_START_TOKEN
) ? nfs_volume_list
.next
: _p
->next
;
1354 return _p
!= &nfs_volume_list
? _p
: NULL
;
1358 * clean up after reading from the transports list
1360 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
)
1362 spin_unlock(&nfs_client_lock
);
1366 * display a header line followed by a load of call lines
1368 static int nfs_volume_list_show(struct seq_file
*m
, void *v
)
1370 struct nfs_server
*server
;
1371 struct nfs_client
*clp
;
1372 char dev
[8], fsid
[17];
1374 /* display header on line 1 */
1375 if (v
== SEQ_START_TOKEN
) {
1376 seq_puts(m
, "NV SERVER PORT DEV FSID\n");
1379 /* display one transport per line on subsequent lines */
1380 server
= list_entry(v
, struct nfs_server
, master_link
);
1381 clp
= server
->nfs_client
;
1383 snprintf(dev
, 8, "%u:%u",
1384 MAJOR(server
->s_dev
), MINOR(server
->s_dev
));
1386 snprintf(fsid
, 17, "%llx:%llx",
1387 (unsigned long long) server
->fsid
.major
,
1388 (unsigned long long) server
->fsid
.minor
);
1390 seq_printf(m
, "v%d %02x%02x%02x%02x %4hx %-7s %-17s\n",
1392 NIPQUAD(clp
->cl_addr
.sin_addr
),
1393 ntohs(clp
->cl_addr
.sin_port
),
1401 * initialise the /proc/fs/nfsfs/ directory
1403 int __init
nfs_fs_proc_init(void)
1405 struct proc_dir_entry
*p
;
1407 proc_fs_nfs
= proc_mkdir("nfsfs", proc_root_fs
);
1411 proc_fs_nfs
->owner
= THIS_MODULE
;
1413 /* a file of servers with which we're dealing */
1414 p
= create_proc_entry("servers", S_IFREG
|S_IRUGO
, proc_fs_nfs
);
1418 p
->proc_fops
= &nfs_server_list_fops
;
1419 p
->owner
= THIS_MODULE
;
1421 /* a file of volumes that we have mounted */
1422 p
= create_proc_entry("volumes", S_IFREG
|S_IRUGO
, proc_fs_nfs
);
1426 p
->proc_fops
= &nfs_volume_list_fops
;
1427 p
->owner
= THIS_MODULE
;
1431 remove_proc_entry("servers", proc_fs_nfs
);
1433 remove_proc_entry("nfsfs", proc_root_fs
);
1439 * clean up the /proc/fs/nfsfs/ directory
1441 void nfs_fs_proc_exit(void)
1443 remove_proc_entry("volumes", proc_fs_nfs
);
1444 remove_proc_entry("servers", proc_fs_nfs
);
1445 remove_proc_entry("nfsfs", proc_root_fs
);
1448 #endif /* CONFIG_PROC_FS */