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
;
107 * Allocate a shared client record
109 * Since these are allocated/deallocated very rarely, we don't
110 * bother putting them in a slab cache...
112 static struct nfs_client
*nfs_alloc_client(const struct nfs_client_initdata
*cl_init
)
114 struct nfs_client
*clp
;
115 struct rpc_cred
*cred
;
117 if ((clp
= kzalloc(sizeof(*clp
), GFP_KERNEL
)) == NULL
)
120 clp
->rpc_ops
= cl_init
->rpc_ops
;
122 if (cl_init
->rpc_ops
->version
== 4) {
123 if (nfs_callback_up() < 0)
125 __set_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
);
128 atomic_set(&clp
->cl_count
, 1);
129 clp
->cl_cons_state
= NFS_CS_INITING
;
131 memcpy(&clp
->cl_addr
, cl_init
->addr
, cl_init
->addrlen
);
132 clp
->cl_addrlen
= cl_init
->addrlen
;
134 if (cl_init
->hostname
) {
135 clp
->cl_hostname
= kstrdup(cl_init
->hostname
, GFP_KERNEL
);
136 if (!clp
->cl_hostname
)
140 INIT_LIST_HEAD(&clp
->cl_superblocks
);
141 clp
->cl_rpcclient
= ERR_PTR(-EINVAL
);
143 clp
->cl_proto
= cl_init
->proto
;
146 init_rwsem(&clp
->cl_sem
);
147 INIT_LIST_HEAD(&clp
->cl_delegations
);
148 spin_lock_init(&clp
->cl_lock
);
149 INIT_DELAYED_WORK(&clp
->cl_renewd
, nfs4_renew_state
);
150 rpc_init_wait_queue(&clp
->cl_rpcwaitq
, "NFS client");
151 clp
->cl_boot_time
= CURRENT_TIME
;
152 clp
->cl_state
= 1 << NFS4CLNT_LEASE_EXPIRED
;
154 cred
= rpc_lookup_machine_cred();
156 clp
->cl_machine_cred
= cred
;
161 if (__test_and_clear_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
))
169 static void nfs4_shutdown_client(struct nfs_client
*clp
)
172 if (__test_and_clear_bit(NFS_CS_RENEWD
, &clp
->cl_res_state
))
173 nfs4_kill_renewd(clp
);
174 BUG_ON(!RB_EMPTY_ROOT(&clp
->cl_state_owners
));
175 if (__test_and_clear_bit(NFS_CS_IDMAP
, &clp
->cl_res_state
))
176 nfs_idmap_delete(clp
);
178 rpc_destroy_wait_queue(&clp
->cl_rpcwaitq
);
183 * Destroy a shared client record
185 static void nfs_free_client(struct nfs_client
*clp
)
187 dprintk("--> nfs_free_client(%u)\n", clp
->rpc_ops
->version
);
189 nfs4_shutdown_client(clp
);
191 /* -EIO all pending I/O */
192 if (!IS_ERR(clp
->cl_rpcclient
))
193 rpc_shutdown_client(clp
->cl_rpcclient
);
195 if (__test_and_clear_bit(NFS_CS_CALLBACK
, &clp
->cl_res_state
))
198 if (clp
->cl_machine_cred
!= NULL
)
199 put_rpccred(clp
->cl_machine_cred
);
201 kfree(clp
->cl_hostname
);
204 dprintk("<-- nfs_free_client()\n");
208 * Release a reference to a shared client record
210 void nfs_put_client(struct nfs_client
*clp
)
215 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp
->cl_count
));
217 if (atomic_dec_and_lock(&clp
->cl_count
, &nfs_client_lock
)) {
218 list_del(&clp
->cl_share_link
);
219 spin_unlock(&nfs_client_lock
);
221 BUG_ON(!list_empty(&clp
->cl_superblocks
));
223 nfs_free_client(clp
);
227 static int nfs_sockaddr_match_ipaddr4(const struct sockaddr_in
*sa1
,
228 const struct sockaddr_in
*sa2
)
230 return sa1
->sin_addr
.s_addr
== sa2
->sin_addr
.s_addr
;
233 static int nfs_sockaddr_match_ipaddr6(const struct sockaddr_in6
*sa1
,
234 const struct sockaddr_in6
*sa2
)
236 return ipv6_addr_equal(&sa1
->sin6_addr
, &sa2
->sin6_addr
);
239 static int nfs_sockaddr_match_ipaddr(const struct sockaddr
*sa1
,
240 const struct sockaddr
*sa2
)
242 switch (sa1
->sa_family
) {
244 return nfs_sockaddr_match_ipaddr4((const struct sockaddr_in
*)sa1
,
245 (const struct sockaddr_in
*)sa2
);
247 return nfs_sockaddr_match_ipaddr6((const struct sockaddr_in6
*)sa1
,
248 (const struct sockaddr_in6
*)sa2
);
254 * Find a client by IP address and protocol version
255 * - returns NULL if no such client
257 struct nfs_client
*nfs_find_client(const struct sockaddr
*addr
, u32 nfsversion
)
259 struct nfs_client
*clp
;
261 spin_lock(&nfs_client_lock
);
262 list_for_each_entry(clp
, &nfs_client_list
, cl_share_link
) {
263 struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
265 /* Don't match clients that failed to initialise properly */
266 if (clp
->cl_cons_state
!= NFS_CS_READY
)
269 /* Different NFS versions cannot share the same nfs_client */
270 if (clp
->rpc_ops
->version
!= nfsversion
)
273 if (addr
->sa_family
!= clap
->sa_family
)
275 /* Match only the IP address, not the port number */
276 if (!nfs_sockaddr_match_ipaddr(addr
, clap
))
279 atomic_inc(&clp
->cl_count
);
280 spin_unlock(&nfs_client_lock
);
283 spin_unlock(&nfs_client_lock
);
288 * Find a client by IP address and protocol version
289 * - returns NULL if no such client
291 struct nfs_client
*nfs_find_client_next(struct nfs_client
*clp
)
293 struct sockaddr
*sap
= (struct sockaddr
*)&clp
->cl_addr
;
294 u32 nfsvers
= clp
->rpc_ops
->version
;
296 spin_lock(&nfs_client_lock
);
297 list_for_each_entry_continue(clp
, &nfs_client_list
, cl_share_link
) {
298 struct sockaddr
*clap
= (struct sockaddr
*)&clp
->cl_addr
;
300 /* Don't match clients that failed to initialise properly */
301 if (clp
->cl_cons_state
!= NFS_CS_READY
)
304 /* Different NFS versions cannot share the same nfs_client */
305 if (clp
->rpc_ops
->version
!= nfsvers
)
308 if (sap
->sa_family
!= clap
->sa_family
)
310 /* Match only the IP address, not the port number */
311 if (!nfs_sockaddr_match_ipaddr(sap
, clap
))
314 atomic_inc(&clp
->cl_count
);
315 spin_unlock(&nfs_client_lock
);
318 spin_unlock(&nfs_client_lock
);
323 * Find an nfs_client on the list that matches the initialisation data
326 static struct nfs_client
*nfs_match_client(const struct nfs_client_initdata
*data
)
328 struct nfs_client
*clp
;
330 list_for_each_entry(clp
, &nfs_client_list
, cl_share_link
) {
331 /* Don't match clients that failed to initialise properly */
332 if (clp
->cl_cons_state
< 0)
335 /* Different NFS versions cannot share the same nfs_client */
336 if (clp
->rpc_ops
!= data
->rpc_ops
)
339 if (clp
->cl_proto
!= data
->proto
)
342 /* Match the full socket address */
343 if (memcmp(&clp
->cl_addr
, data
->addr
, sizeof(clp
->cl_addr
)) != 0)
346 atomic_inc(&clp
->cl_count
);
353 * Look up a client by IP address and protocol version
354 * - creates a new record if one doesn't yet exist
356 static struct nfs_client
*nfs_get_client(const struct nfs_client_initdata
*cl_init
)
358 struct nfs_client
*clp
, *new = NULL
;
361 dprintk("--> nfs_get_client(%s,v%u)\n",
362 cl_init
->hostname
?: "", cl_init
->rpc_ops
->version
);
364 /* see if the client already exists */
366 spin_lock(&nfs_client_lock
);
368 clp
= nfs_match_client(cl_init
);
374 spin_unlock(&nfs_client_lock
);
376 new = nfs_alloc_client(cl_init
);
379 return ERR_PTR(-ENOMEM
);
381 /* install a new client and return with it unready */
384 list_add(&clp
->cl_share_link
, &nfs_client_list
);
385 spin_unlock(&nfs_client_lock
);
386 dprintk("--> nfs_get_client() = %p [new]\n", clp
);
389 /* found an existing client
390 * - make sure it's ready before returning
393 spin_unlock(&nfs_client_lock
);
396 nfs_free_client(new);
398 error
= wait_event_killable(nfs_client_active_wq
,
399 clp
->cl_cons_state
!= NFS_CS_INITING
);
402 return ERR_PTR(-ERESTARTSYS
);
405 if (clp
->cl_cons_state
< NFS_CS_READY
) {
406 error
= clp
->cl_cons_state
;
408 return ERR_PTR(error
);
411 BUG_ON(clp
->cl_cons_state
!= NFS_CS_READY
);
413 dprintk("--> nfs_get_client() = %p [share]\n", clp
);
418 * Mark a server as ready or failed
420 static void nfs_mark_client_ready(struct nfs_client
*clp
, int state
)
422 clp
->cl_cons_state
= state
;
423 wake_up_all(&nfs_client_active_wq
);
427 * Initialise the timeout values for a connection
429 static void nfs_init_timeout_values(struct rpc_timeout
*to
, int proto
,
430 unsigned int timeo
, unsigned int retrans
)
432 to
->to_initval
= timeo
* HZ
/ 10;
433 to
->to_retries
= retrans
;
436 case XPRT_TRANSPORT_TCP
:
437 case XPRT_TRANSPORT_RDMA
:
438 if (to
->to_retries
== 0)
439 to
->to_retries
= NFS_DEF_TCP_RETRANS
;
440 if (to
->to_initval
== 0)
441 to
->to_initval
= NFS_DEF_TCP_TIMEO
* HZ
/ 10;
442 if (to
->to_initval
> NFS_MAX_TCP_TIMEOUT
)
443 to
->to_initval
= NFS_MAX_TCP_TIMEOUT
;
444 to
->to_increment
= to
->to_initval
;
445 to
->to_maxval
= to
->to_initval
+ (to
->to_increment
* to
->to_retries
);
446 if (to
->to_maxval
> NFS_MAX_TCP_TIMEOUT
)
447 to
->to_maxval
= NFS_MAX_TCP_TIMEOUT
;
448 if (to
->to_maxval
< to
->to_initval
)
449 to
->to_maxval
= to
->to_initval
;
450 to
->to_exponential
= 0;
452 case XPRT_TRANSPORT_UDP
:
453 if (to
->to_retries
== 0)
454 to
->to_retries
= NFS_DEF_UDP_RETRANS
;
456 to
->to_initval
= NFS_DEF_UDP_TIMEO
* HZ
/ 10;
457 if (to
->to_initval
> NFS_MAX_UDP_TIMEOUT
)
458 to
->to_initval
= NFS_MAX_UDP_TIMEOUT
;
459 to
->to_maxval
= NFS_MAX_UDP_TIMEOUT
;
460 to
->to_exponential
= 1;
468 * Create an RPC client handle
470 static int nfs_create_rpc_client(struct nfs_client
*clp
,
471 const struct rpc_timeout
*timeparms
,
472 rpc_authflavor_t flavor
,
475 struct rpc_clnt
*clnt
= NULL
;
476 struct rpc_create_args args
= {
477 .protocol
= clp
->cl_proto
,
478 .address
= (struct sockaddr
*)&clp
->cl_addr
,
479 .addrsize
= clp
->cl_addrlen
,
480 .timeout
= timeparms
,
481 .servername
= clp
->cl_hostname
,
482 .program
= &nfs_program
,
483 .version
= clp
->rpc_ops
->version
,
484 .authflavor
= flavor
,
488 if (!IS_ERR(clp
->cl_rpcclient
))
491 clnt
= rpc_create(&args
);
493 dprintk("%s: cannot create RPC client. Error = %ld\n",
494 __func__
, PTR_ERR(clnt
));
495 return PTR_ERR(clnt
);
498 clp
->cl_rpcclient
= clnt
;
503 * Version 2 or 3 client destruction
505 static void nfs_destroy_server(struct nfs_server
*server
)
507 if (!(server
->flags
& NFS_MOUNT_NONLM
))
508 nlmclnt_done(server
->nlm_host
);
512 * Version 2 or 3 lockd setup
514 static int nfs_start_lockd(struct nfs_server
*server
)
516 struct nlm_host
*host
;
517 struct nfs_client
*clp
= server
->nfs_client
;
518 struct nlmclnt_initdata nlm_init
= {
519 .hostname
= clp
->cl_hostname
,
520 .address
= (struct sockaddr
*)&clp
->cl_addr
,
521 .addrlen
= clp
->cl_addrlen
,
522 .protocol
= server
->flags
& NFS_MOUNT_TCP
?
523 IPPROTO_TCP
: IPPROTO_UDP
,
524 .nfs_version
= clp
->rpc_ops
->version
,
527 if (nlm_init
.nfs_version
> 3)
529 if (server
->flags
& NFS_MOUNT_NONLM
)
532 host
= nlmclnt_init(&nlm_init
);
534 return PTR_ERR(host
);
536 server
->nlm_host
= host
;
537 server
->destroy
= nfs_destroy_server
;
542 * Initialise an NFSv3 ACL client connection
544 #ifdef CONFIG_NFS_V3_ACL
545 static void nfs_init_server_aclclient(struct nfs_server
*server
)
547 if (server
->nfs_client
->rpc_ops
->version
!= 3)
549 if (server
->flags
& NFS_MOUNT_NOACL
)
552 server
->client_acl
= rpc_bind_new_program(server
->client
, &nfsacl_program
, 3);
553 if (IS_ERR(server
->client_acl
))
556 /* No errors! Assume that Sun nfsacls are supported */
557 server
->caps
|= NFS_CAP_ACLS
;
561 server
->caps
&= ~NFS_CAP_ACLS
;
564 static inline void nfs_init_server_aclclient(struct nfs_server
*server
)
566 server
->flags
&= ~NFS_MOUNT_NOACL
;
567 server
->caps
&= ~NFS_CAP_ACLS
;
572 * Create a general RPC client
574 static int nfs_init_server_rpcclient(struct nfs_server
*server
,
575 const struct rpc_timeout
*timeo
,
576 rpc_authflavor_t pseudoflavour
)
578 struct nfs_client
*clp
= server
->nfs_client
;
580 server
->client
= rpc_clone_client(clp
->cl_rpcclient
);
581 if (IS_ERR(server
->client
)) {
582 dprintk("%s: couldn't create rpc_client!\n", __func__
);
583 return PTR_ERR(server
->client
);
586 memcpy(&server
->client
->cl_timeout_default
,
588 sizeof(server
->client
->cl_timeout_default
));
589 server
->client
->cl_timeout
= &server
->client
->cl_timeout_default
;
591 if (pseudoflavour
!= clp
->cl_rpcclient
->cl_auth
->au_flavor
) {
592 struct rpc_auth
*auth
;
594 auth
= rpcauth_create(pseudoflavour
, server
->client
);
596 dprintk("%s: couldn't create credcache!\n", __func__
);
597 return PTR_ERR(auth
);
600 server
->client
->cl_softrtry
= 0;
601 if (server
->flags
& NFS_MOUNT_SOFT
)
602 server
->client
->cl_softrtry
= 1;
608 * Initialise an NFS2 or NFS3 client
610 static int nfs_init_client(struct nfs_client
*clp
,
611 const struct rpc_timeout
*timeparms
,
612 const struct nfs_parsed_mount_data
*data
)
616 if (clp
->cl_cons_state
== NFS_CS_READY
) {
617 /* the client is already initialised */
618 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp
);
623 * Create a client RPC handle for doing FSSTAT with UNIX auth only
624 * - RFC 2623, sec 2.3.2
626 error
= nfs_create_rpc_client(clp
, timeparms
, RPC_AUTH_UNIX
, 0);
629 nfs_mark_client_ready(clp
, NFS_CS_READY
);
633 nfs_mark_client_ready(clp
, error
);
634 dprintk("<-- nfs_init_client() = xerror %d\n", error
);
639 * Create a version 2 or 3 client
641 static int nfs_init_server(struct nfs_server
*server
,
642 const struct nfs_parsed_mount_data
*data
)
644 struct nfs_client_initdata cl_init
= {
645 .hostname
= data
->nfs_server
.hostname
,
646 .addr
= (const struct sockaddr
*)&data
->nfs_server
.address
,
647 .addrlen
= data
->nfs_server
.addrlen
,
648 .rpc_ops
= &nfs_v2_clientops
,
649 .proto
= data
->nfs_server
.protocol
,
651 struct rpc_timeout timeparms
;
652 struct nfs_client
*clp
;
655 dprintk("--> nfs_init_server()\n");
658 if (data
->flags
& NFS_MOUNT_VER3
)
659 cl_init
.rpc_ops
= &nfs_v3_clientops
;
662 /* Allocate or find a client reference we can use */
663 clp
= nfs_get_client(&cl_init
);
665 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp
));
669 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
670 data
->timeo
, data
->retrans
);
671 error
= nfs_init_client(clp
, &timeparms
, data
);
675 server
->nfs_client
= clp
;
677 /* Initialise the client representation from the mount data */
678 server
->flags
= data
->flags
& NFS_MOUNT_FLAGMASK
;
681 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
683 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
685 server
->acregmin
= data
->acregmin
* HZ
;
686 server
->acregmax
= data
->acregmax
* HZ
;
687 server
->acdirmin
= data
->acdirmin
* HZ
;
688 server
->acdirmax
= data
->acdirmax
* HZ
;
690 /* Start lockd here, before we might error out */
691 error
= nfs_start_lockd(server
);
695 server
->port
= data
->nfs_server
.port
;
697 error
= nfs_init_server_rpcclient(server
, &timeparms
, data
->auth_flavors
[0]);
701 /* Preserve the values of mount_server-related mount options */
702 if (data
->mount_server
.addrlen
) {
703 memcpy(&server
->mountd_address
, &data
->mount_server
.address
,
704 data
->mount_server
.addrlen
);
705 server
->mountd_addrlen
= data
->mount_server
.addrlen
;
707 server
->mountd_version
= data
->mount_server
.version
;
708 server
->mountd_port
= data
->mount_server
.port
;
709 server
->mountd_protocol
= data
->mount_server
.protocol
;
711 server
->namelen
= data
->namlen
;
712 /* Create a client RPC handle for the NFSv3 ACL management interface */
713 nfs_init_server_aclclient(server
);
714 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp
);
718 server
->nfs_client
= NULL
;
720 dprintk("<-- nfs_init_server() = xerror %d\n", error
);
725 * Load up the server record from information gained in an fsinfo record
727 static void nfs_server_set_fsinfo(struct nfs_server
*server
, struct nfs_fsinfo
*fsinfo
)
729 unsigned long max_rpc_payload
;
731 /* Work out a lot of parameters */
732 if (server
->rsize
== 0)
733 server
->rsize
= nfs_block_size(fsinfo
->rtpref
, NULL
);
734 if (server
->wsize
== 0)
735 server
->wsize
= nfs_block_size(fsinfo
->wtpref
, NULL
);
737 if (fsinfo
->rtmax
>= 512 && server
->rsize
> fsinfo
->rtmax
)
738 server
->rsize
= nfs_block_size(fsinfo
->rtmax
, NULL
);
739 if (fsinfo
->wtmax
>= 512 && server
->wsize
> fsinfo
->wtmax
)
740 server
->wsize
= nfs_block_size(fsinfo
->wtmax
, NULL
);
742 max_rpc_payload
= nfs_block_size(rpc_max_payload(server
->client
), NULL
);
743 if (server
->rsize
> max_rpc_payload
)
744 server
->rsize
= max_rpc_payload
;
745 if (server
->rsize
> NFS_MAX_FILE_IO_SIZE
)
746 server
->rsize
= NFS_MAX_FILE_IO_SIZE
;
747 server
->rpages
= (server
->rsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
749 server
->backing_dev_info
.ra_pages
= server
->rpages
* NFS_MAX_READAHEAD
;
751 if (server
->wsize
> max_rpc_payload
)
752 server
->wsize
= max_rpc_payload
;
753 if (server
->wsize
> NFS_MAX_FILE_IO_SIZE
)
754 server
->wsize
= NFS_MAX_FILE_IO_SIZE
;
755 server
->wpages
= (server
->wsize
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
756 server
->wtmult
= nfs_block_bits(fsinfo
->wtmult
, NULL
);
758 server
->dtsize
= nfs_block_size(fsinfo
->dtpref
, NULL
);
759 if (server
->dtsize
> PAGE_CACHE_SIZE
)
760 server
->dtsize
= PAGE_CACHE_SIZE
;
761 if (server
->dtsize
> server
->rsize
)
762 server
->dtsize
= server
->rsize
;
764 if (server
->flags
& NFS_MOUNT_NOAC
) {
765 server
->acregmin
= server
->acregmax
= 0;
766 server
->acdirmin
= server
->acdirmax
= 0;
769 server
->maxfilesize
= fsinfo
->maxfilesize
;
771 /* We're airborne Set socket buffersize */
772 rpc_setbufsize(server
->client
, server
->wsize
+ 100, server
->rsize
+ 100);
776 * Probe filesystem information, including the FSID on v2/v3
778 static int nfs_probe_fsinfo(struct nfs_server
*server
, struct nfs_fh
*mntfh
, struct nfs_fattr
*fattr
)
780 struct nfs_fsinfo fsinfo
;
781 struct nfs_client
*clp
= server
->nfs_client
;
784 dprintk("--> nfs_probe_fsinfo()\n");
786 if (clp
->rpc_ops
->set_capabilities
!= NULL
) {
787 error
= clp
->rpc_ops
->set_capabilities(server
, mntfh
);
792 fsinfo
.fattr
= fattr
;
793 nfs_fattr_init(fattr
);
794 error
= clp
->rpc_ops
->fsinfo(server
, mntfh
, &fsinfo
);
798 nfs_server_set_fsinfo(server
, &fsinfo
);
799 error
= bdi_init(&server
->backing_dev_info
);
804 /* Get some general file system info */
805 if (server
->namelen
== 0) {
806 struct nfs_pathconf pathinfo
;
808 pathinfo
.fattr
= fattr
;
809 nfs_fattr_init(fattr
);
811 if (clp
->rpc_ops
->pathconf(server
, mntfh
, &pathinfo
) >= 0)
812 server
->namelen
= pathinfo
.max_namelen
;
815 dprintk("<-- nfs_probe_fsinfo() = 0\n");
819 dprintk("nfs_probe_fsinfo: error = %d\n", -error
);
824 * Copy useful information when duplicating a server record
826 static void nfs_server_copy_userdata(struct nfs_server
*target
, struct nfs_server
*source
)
828 target
->flags
= source
->flags
;
829 target
->rsize
= source
->rsize
;
830 target
->wsize
= source
->wsize
;
831 target
->acregmin
= source
->acregmin
;
832 target
->acregmax
= source
->acregmax
;
833 target
->acdirmin
= source
->acdirmin
;
834 target
->acdirmax
= source
->acdirmax
;
835 target
->caps
= source
->caps
;
839 * Allocate and initialise a server record
841 static struct nfs_server
*nfs_alloc_server(void)
843 struct nfs_server
*server
;
845 server
= kzalloc(sizeof(struct nfs_server
), GFP_KERNEL
);
849 server
->client
= server
->client_acl
= ERR_PTR(-EINVAL
);
851 /* Zero out the NFS state stuff */
852 INIT_LIST_HEAD(&server
->client_link
);
853 INIT_LIST_HEAD(&server
->master_link
);
855 init_waitqueue_head(&server
->active_wq
);
856 atomic_set(&server
->active
, 0);
858 server
->io_stats
= nfs_alloc_iostats();
859 if (!server
->io_stats
) {
868 * Free up a server record
870 void nfs_free_server(struct nfs_server
*server
)
872 dprintk("--> nfs_free_server()\n");
874 spin_lock(&nfs_client_lock
);
875 list_del(&server
->client_link
);
876 list_del(&server
->master_link
);
877 spin_unlock(&nfs_client_lock
);
879 if (server
->destroy
!= NULL
)
880 server
->destroy(server
);
882 if (!IS_ERR(server
->client_acl
))
883 rpc_shutdown_client(server
->client_acl
);
884 if (!IS_ERR(server
->client
))
885 rpc_shutdown_client(server
->client
);
887 nfs_put_client(server
->nfs_client
);
889 nfs_free_iostats(server
->io_stats
);
890 bdi_destroy(&server
->backing_dev_info
);
892 nfs_release_automount_timer();
893 dprintk("<-- nfs_free_server()\n");
897 * Create a version 2 or 3 volume record
898 * - keyed on server and FSID
900 struct nfs_server
*nfs_create_server(const struct nfs_parsed_mount_data
*data
,
901 struct nfs_fh
*mntfh
)
903 struct nfs_server
*server
;
904 struct nfs_fattr fattr
;
907 server
= nfs_alloc_server();
909 return ERR_PTR(-ENOMEM
);
911 /* Get a client representation */
912 error
= nfs_init_server(server
, data
);
916 BUG_ON(!server
->nfs_client
);
917 BUG_ON(!server
->nfs_client
->rpc_ops
);
918 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
920 /* Probe the root fh to retrieve its FSID */
921 error
= nfs_probe_fsinfo(server
, mntfh
, &fattr
);
924 if (server
->nfs_client
->rpc_ops
->version
== 3) {
925 if (server
->namelen
== 0 || server
->namelen
> NFS3_MAXNAMLEN
)
926 server
->namelen
= NFS3_MAXNAMLEN
;
927 if (!(data
->flags
& NFS_MOUNT_NORDIRPLUS
))
928 server
->caps
|= NFS_CAP_READDIRPLUS
;
930 if (server
->namelen
== 0 || server
->namelen
> NFS2_MAXNAMLEN
)
931 server
->namelen
= NFS2_MAXNAMLEN
;
934 if (!(fattr
.valid
& NFS_ATTR_FATTR
)) {
935 error
= server
->nfs_client
->rpc_ops
->getattr(server
, mntfh
, &fattr
);
937 dprintk("nfs_create_server: getattr error = %d\n", -error
);
941 memcpy(&server
->fsid
, &fattr
.fsid
, sizeof(server
->fsid
));
943 dprintk("Server FSID: %llx:%llx\n",
944 (unsigned long long) server
->fsid
.major
,
945 (unsigned long long) server
->fsid
.minor
);
947 BUG_ON(!server
->nfs_client
);
948 BUG_ON(!server
->nfs_client
->rpc_ops
);
949 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
951 spin_lock(&nfs_client_lock
);
952 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
953 list_add_tail(&server
->master_link
, &nfs_volume_list
);
954 spin_unlock(&nfs_client_lock
);
956 server
->mount_time
= jiffies
;
960 nfs_free_server(server
);
961 return ERR_PTR(error
);
966 * Initialise an NFS4 client record
968 static int nfs4_init_client(struct nfs_client
*clp
,
969 const struct rpc_timeout
*timeparms
,
971 rpc_authflavor_t authflavour
)
975 if (clp
->cl_cons_state
== NFS_CS_READY
) {
976 /* the client is initialised already */
977 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp
);
981 /* Check NFS protocol revision and initialize RPC op vector */
982 clp
->rpc_ops
= &nfs_v4_clientops
;
984 error
= nfs_create_rpc_client(clp
, timeparms
, authflavour
,
985 RPC_CLNT_CREATE_DISCRTRY
);
988 strlcpy(clp
->cl_ipaddr
, ip_addr
, sizeof(clp
->cl_ipaddr
));
990 error
= nfs_idmap_new(clp
);
992 dprintk("%s: failed to create idmapper. Error = %d\n",
996 __set_bit(NFS_CS_IDMAP
, &clp
->cl_res_state
);
998 nfs_mark_client_ready(clp
, NFS_CS_READY
);
1002 nfs_mark_client_ready(clp
, error
);
1003 dprintk("<-- nfs4_init_client() = xerror %d\n", error
);
1008 * Set up an NFS4 client
1010 static int nfs4_set_client(struct nfs_server
*server
,
1011 const char *hostname
,
1012 const struct sockaddr
*addr
,
1013 const size_t addrlen
,
1014 const char *ip_addr
,
1015 rpc_authflavor_t authflavour
,
1016 int proto
, const struct rpc_timeout
*timeparms
)
1018 struct nfs_client_initdata cl_init
= {
1019 .hostname
= hostname
,
1022 .rpc_ops
= &nfs_v4_clientops
,
1025 struct nfs_client
*clp
;
1028 dprintk("--> nfs4_set_client()\n");
1030 /* Allocate or find a client reference we can use */
1031 clp
= nfs_get_client(&cl_init
);
1033 error
= PTR_ERR(clp
);
1036 error
= nfs4_init_client(clp
, timeparms
, ip_addr
, authflavour
);
1040 server
->nfs_client
= clp
;
1041 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp
);
1045 nfs_put_client(clp
);
1047 dprintk("<-- nfs4_set_client() = xerror %d\n", error
);
1052 * Create a version 4 volume record
1054 static int nfs4_init_server(struct nfs_server
*server
,
1055 const struct nfs_parsed_mount_data
*data
)
1057 struct rpc_timeout timeparms
;
1060 dprintk("--> nfs4_init_server()\n");
1062 nfs_init_timeout_values(&timeparms
, data
->nfs_server
.protocol
,
1063 data
->timeo
, data
->retrans
);
1065 /* Get a client record */
1066 error
= nfs4_set_client(server
,
1067 data
->nfs_server
.hostname
,
1068 (const struct sockaddr
*)&data
->nfs_server
.address
,
1069 data
->nfs_server
.addrlen
,
1070 data
->client_address
,
1071 data
->auth_flavors
[0],
1072 data
->nfs_server
.protocol
,
1077 /* Initialise the client representation from the mount data */
1078 server
->flags
= data
->flags
& NFS_MOUNT_FLAGMASK
;
1079 server
->caps
|= NFS_CAP_ATOMIC_OPEN
;
1082 server
->rsize
= nfs_block_size(data
->rsize
, NULL
);
1084 server
->wsize
= nfs_block_size(data
->wsize
, NULL
);
1086 server
->acregmin
= data
->acregmin
* HZ
;
1087 server
->acregmax
= data
->acregmax
* HZ
;
1088 server
->acdirmin
= data
->acdirmin
* HZ
;
1089 server
->acdirmax
= data
->acdirmax
* HZ
;
1091 server
->port
= data
->nfs_server
.port
;
1093 error
= nfs_init_server_rpcclient(server
, &timeparms
, data
->auth_flavors
[0]);
1097 dprintk("<-- nfs4_init_server() = %d\n", error
);
1102 * Create a version 4 volume record
1103 * - keyed on server and FSID
1105 struct nfs_server
*nfs4_create_server(const struct nfs_parsed_mount_data
*data
,
1106 struct nfs_fh
*mntfh
)
1108 struct nfs_fattr fattr
;
1109 struct nfs_server
*server
;
1112 dprintk("--> nfs4_create_server()\n");
1114 server
= nfs_alloc_server();
1116 return ERR_PTR(-ENOMEM
);
1118 /* set up the general RPC client */
1119 error
= nfs4_init_server(server
, data
);
1123 BUG_ON(!server
->nfs_client
);
1124 BUG_ON(!server
->nfs_client
->rpc_ops
);
1125 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1127 /* Probe the root fh to retrieve its FSID */
1128 error
= nfs4_path_walk(server
, mntfh
, data
->nfs_server
.export_path
);
1132 dprintk("Server FSID: %llx:%llx\n",
1133 (unsigned long long) server
->fsid
.major
,
1134 (unsigned long long) server
->fsid
.minor
);
1135 dprintk("Mount FH: %d\n", mntfh
->size
);
1137 error
= nfs_probe_fsinfo(server
, mntfh
, &fattr
);
1141 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1142 server
->namelen
= NFS4_MAXNAMLEN
;
1144 BUG_ON(!server
->nfs_client
);
1145 BUG_ON(!server
->nfs_client
->rpc_ops
);
1146 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1148 spin_lock(&nfs_client_lock
);
1149 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
1150 list_add_tail(&server
->master_link
, &nfs_volume_list
);
1151 spin_unlock(&nfs_client_lock
);
1153 server
->mount_time
= jiffies
;
1154 dprintk("<-- nfs4_create_server() = %p\n", server
);
1158 nfs_free_server(server
);
1159 dprintk("<-- nfs4_create_server() = error %d\n", error
);
1160 return ERR_PTR(error
);
1164 * Create an NFS4 referral server record
1166 struct nfs_server
*nfs4_create_referral_server(struct nfs_clone_mount
*data
,
1167 struct nfs_fh
*mntfh
)
1169 struct nfs_client
*parent_client
;
1170 struct nfs_server
*server
, *parent_server
;
1171 struct nfs_fattr fattr
;
1174 dprintk("--> nfs4_create_referral_server()\n");
1176 server
= nfs_alloc_server();
1178 return ERR_PTR(-ENOMEM
);
1180 parent_server
= NFS_SB(data
->sb
);
1181 parent_client
= parent_server
->nfs_client
;
1183 /* Get a client representation.
1184 * Note: NFSv4 always uses TCP, */
1185 error
= nfs4_set_client(server
, data
->hostname
,
1188 parent_client
->cl_ipaddr
,
1190 parent_server
->client
->cl_xprt
->prot
,
1191 parent_server
->client
->cl_timeout
);
1195 /* Initialise the client representation from the parent server */
1196 nfs_server_copy_userdata(server
, parent_server
);
1197 server
->caps
|= NFS_CAP_ATOMIC_OPEN
;
1199 error
= nfs_init_server_rpcclient(server
, parent_server
->client
->cl_timeout
, data
->authflavor
);
1203 BUG_ON(!server
->nfs_client
);
1204 BUG_ON(!server
->nfs_client
->rpc_ops
);
1205 BUG_ON(!server
->nfs_client
->rpc_ops
->file_inode_ops
);
1207 /* Probe the root fh to retrieve its FSID and filehandle */
1208 error
= nfs4_path_walk(server
, mntfh
, data
->mnt_path
);
1212 /* probe the filesystem info for this server filesystem */
1213 error
= nfs_probe_fsinfo(server
, mntfh
, &fattr
);
1217 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1218 server
->namelen
= NFS4_MAXNAMLEN
;
1220 dprintk("Referral FSID: %llx:%llx\n",
1221 (unsigned long long) server
->fsid
.major
,
1222 (unsigned long long) server
->fsid
.minor
);
1224 spin_lock(&nfs_client_lock
);
1225 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
1226 list_add_tail(&server
->master_link
, &nfs_volume_list
);
1227 spin_unlock(&nfs_client_lock
);
1229 server
->mount_time
= jiffies
;
1231 dprintk("<-- nfs_create_referral_server() = %p\n", server
);
1235 nfs_free_server(server
);
1236 dprintk("<-- nfs4_create_referral_server() = error %d\n", error
);
1237 return ERR_PTR(error
);
1240 #endif /* CONFIG_NFS_V4 */
1243 * Clone an NFS2, NFS3 or NFS4 server record
1245 struct nfs_server
*nfs_clone_server(struct nfs_server
*source
,
1247 struct nfs_fattr
*fattr
)
1249 struct nfs_server
*server
;
1250 struct nfs_fattr fattr_fsinfo
;
1253 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1254 (unsigned long long) fattr
->fsid
.major
,
1255 (unsigned long long) fattr
->fsid
.minor
);
1257 server
= nfs_alloc_server();
1259 return ERR_PTR(-ENOMEM
);
1261 /* Copy data from the source */
1262 server
->nfs_client
= source
->nfs_client
;
1263 atomic_inc(&server
->nfs_client
->cl_count
);
1264 nfs_server_copy_userdata(server
, source
);
1266 server
->fsid
= fattr
->fsid
;
1268 error
= nfs_init_server_rpcclient(server
,
1269 source
->client
->cl_timeout
,
1270 source
->client
->cl_auth
->au_flavor
);
1272 goto out_free_server
;
1273 if (!IS_ERR(source
->client_acl
))
1274 nfs_init_server_aclclient(server
);
1276 /* probe the filesystem info for this server filesystem */
1277 error
= nfs_probe_fsinfo(server
, fh
, &fattr_fsinfo
);
1279 goto out_free_server
;
1281 if (server
->namelen
== 0 || server
->namelen
> NFS4_MAXNAMLEN
)
1282 server
->namelen
= NFS4_MAXNAMLEN
;
1284 dprintk("Cloned FSID: %llx:%llx\n",
1285 (unsigned long long) server
->fsid
.major
,
1286 (unsigned long long) server
->fsid
.minor
);
1288 error
= nfs_start_lockd(server
);
1290 goto out_free_server
;
1292 spin_lock(&nfs_client_lock
);
1293 list_add_tail(&server
->client_link
, &server
->nfs_client
->cl_superblocks
);
1294 list_add_tail(&server
->master_link
, &nfs_volume_list
);
1295 spin_unlock(&nfs_client_lock
);
1297 server
->mount_time
= jiffies
;
1299 dprintk("<-- nfs_clone_server() = %p\n", server
);
1303 nfs_free_server(server
);
1304 dprintk("<-- nfs_clone_server() = error %d\n", error
);
1305 return ERR_PTR(error
);
1308 #ifdef CONFIG_PROC_FS
1309 static struct proc_dir_entry
*proc_fs_nfs
;
1311 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
);
1312 static void *nfs_server_list_start(struct seq_file
*p
, loff_t
*pos
);
1313 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1314 static void nfs_server_list_stop(struct seq_file
*p
, void *v
);
1315 static int nfs_server_list_show(struct seq_file
*m
, void *v
);
1317 static struct seq_operations nfs_server_list_ops
= {
1318 .start
= nfs_server_list_start
,
1319 .next
= nfs_server_list_next
,
1320 .stop
= nfs_server_list_stop
,
1321 .show
= nfs_server_list_show
,
1324 static const struct file_operations nfs_server_list_fops
= {
1325 .open
= nfs_server_list_open
,
1327 .llseek
= seq_lseek
,
1328 .release
= seq_release
,
1329 .owner
= THIS_MODULE
,
1332 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
);
1333 static void *nfs_volume_list_start(struct seq_file
*p
, loff_t
*pos
);
1334 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
);
1335 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
);
1336 static int nfs_volume_list_show(struct seq_file
*m
, void *v
);
1338 static struct seq_operations nfs_volume_list_ops
= {
1339 .start
= nfs_volume_list_start
,
1340 .next
= nfs_volume_list_next
,
1341 .stop
= nfs_volume_list_stop
,
1342 .show
= nfs_volume_list_show
,
1345 static const struct file_operations nfs_volume_list_fops
= {
1346 .open
= nfs_volume_list_open
,
1348 .llseek
= seq_lseek
,
1349 .release
= seq_release
,
1350 .owner
= THIS_MODULE
,
1354 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1357 static int nfs_server_list_open(struct inode
*inode
, struct file
*file
)
1362 ret
= seq_open(file
, &nfs_server_list_ops
);
1366 m
= file
->private_data
;
1367 m
->private = PDE(inode
)->data
;
1373 * set up the iterator to start reading from the server list and return the first item
1375 static void *nfs_server_list_start(struct seq_file
*m
, loff_t
*_pos
)
1377 /* lock the list against modification */
1378 spin_lock(&nfs_client_lock
);
1379 return seq_list_start_head(&nfs_client_list
, *_pos
);
1383 * move to next server
1385 static void *nfs_server_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1387 return seq_list_next(v
, &nfs_client_list
, pos
);
1391 * clean up after reading from the transports list
1393 static void nfs_server_list_stop(struct seq_file
*p
, void *v
)
1395 spin_unlock(&nfs_client_lock
);
1399 * display a header line followed by a load of call lines
1401 static int nfs_server_list_show(struct seq_file
*m
, void *v
)
1403 struct nfs_client
*clp
;
1405 /* display header on line 1 */
1406 if (v
== &nfs_client_list
) {
1407 seq_puts(m
, "NV SERVER PORT USE HOSTNAME\n");
1411 /* display one transport per line on subsequent lines */
1412 clp
= list_entry(v
, struct nfs_client
, cl_share_link
);
1414 seq_printf(m
, "v%u %s %s %3d %s\n",
1415 clp
->rpc_ops
->version
,
1416 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1417 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1418 atomic_read(&clp
->cl_count
),
1425 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1427 static int nfs_volume_list_open(struct inode
*inode
, struct file
*file
)
1432 ret
= seq_open(file
, &nfs_volume_list_ops
);
1436 m
= file
->private_data
;
1437 m
->private = PDE(inode
)->data
;
1443 * set up the iterator to start reading from the volume list and return the first item
1445 static void *nfs_volume_list_start(struct seq_file
*m
, loff_t
*_pos
)
1447 /* lock the list against modification */
1448 spin_lock(&nfs_client_lock
);
1449 return seq_list_start_head(&nfs_volume_list
, *_pos
);
1453 * move to next volume
1455 static void *nfs_volume_list_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
1457 return seq_list_next(v
, &nfs_volume_list
, pos
);
1461 * clean up after reading from the transports list
1463 static void nfs_volume_list_stop(struct seq_file
*p
, void *v
)
1465 spin_unlock(&nfs_client_lock
);
1469 * display a header line followed by a load of call lines
1471 static int nfs_volume_list_show(struct seq_file
*m
, void *v
)
1473 struct nfs_server
*server
;
1474 struct nfs_client
*clp
;
1475 char dev
[8], fsid
[17];
1477 /* display header on line 1 */
1478 if (v
== &nfs_volume_list
) {
1479 seq_puts(m
, "NV SERVER PORT DEV FSID\n");
1482 /* display one transport per line on subsequent lines */
1483 server
= list_entry(v
, struct nfs_server
, master_link
);
1484 clp
= server
->nfs_client
;
1486 snprintf(dev
, 8, "%u:%u",
1487 MAJOR(server
->s_dev
), MINOR(server
->s_dev
));
1489 snprintf(fsid
, 17, "%llx:%llx",
1490 (unsigned long long) server
->fsid
.major
,
1491 (unsigned long long) server
->fsid
.minor
);
1493 seq_printf(m
, "v%u %s %s %-7s %-17s\n",
1494 clp
->rpc_ops
->version
,
1495 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_ADDR
),
1496 rpc_peeraddr2str(clp
->cl_rpcclient
, RPC_DISPLAY_HEX_PORT
),
1504 * initialise the /proc/fs/nfsfs/ directory
1506 int __init
nfs_fs_proc_init(void)
1508 struct proc_dir_entry
*p
;
1510 proc_fs_nfs
= proc_mkdir("fs/nfsfs", NULL
);
1514 proc_fs_nfs
->owner
= THIS_MODULE
;
1516 /* a file of servers with which we're dealing */
1517 p
= proc_create("servers", S_IFREG
|S_IRUGO
,
1518 proc_fs_nfs
, &nfs_server_list_fops
);
1522 /* a file of volumes that we have mounted */
1523 p
= proc_create("volumes", S_IFREG
|S_IRUGO
,
1524 proc_fs_nfs
, &nfs_volume_list_fops
);
1530 remove_proc_entry("servers", proc_fs_nfs
);
1532 remove_proc_entry("fs/nfsfs", NULL
);
1538 * clean up the /proc/fs/nfsfs/ directory
1540 void nfs_fs_proc_exit(void)
1542 remove_proc_entry("volumes", proc_fs_nfs
);
1543 remove_proc_entry("servers", proc_fs_nfs
);
1544 remove_proc_entry("fs/nfsfs", NULL
);
1547 #endif /* CONFIG_PROC_FS */