NFS: patches from linux-nfs.org
[tomato.git] / release / src-rt / linux / linux-2.6 / fs / nfs / client.c
blob61c6dd20dd800e91ba2d761613145c2f19d02bfd
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>
18 #include <linux/mm.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/nfs_fs.h>
27 #include <linux/nfs_mount.h>
28 #include <linux/nfs4_mount.h>
29 #include <linux/lockd/bind.h>
30 #include <linux/seq_file.h>
31 #include <linux/mount.h>
32 #include <linux/nfs_idmap.h>
33 #include <linux/vfs.h>
34 #include <linux/inet.h>
35 #include <linux/nfs_xdr.h>
37 #include <asm/system.h>
39 #include "nfs4_fs.h"
40 #include "callback.h"
41 #include "delegation.h"
42 #include "iostat.h"
43 #include "internal.h"
45 #define NFSDBG_FACILITY NFSDBG_CLIENT
47 static DEFINE_SPINLOCK(nfs_client_lock);
48 static LIST_HEAD(nfs_client_list);
49 static LIST_HEAD(nfs_volume_list);
50 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
53 * RPC cruft for NFS
55 static struct rpc_version *nfs_version[5] = {
56 [2] = &nfs_version2,
57 #ifdef CONFIG_NFS_V3
58 [3] = &nfs_version3,
59 #endif
60 #ifdef CONFIG_NFS_V4
61 [4] = &nfs_version4,
62 #endif
65 struct rpc_program nfs_program = {
66 .name = "nfs",
67 .number = NFS_PROGRAM,
68 .nrvers = ARRAY_SIZE(nfs_version),
69 .version = nfs_version,
70 .stats = &nfs_rpcstat,
71 .pipe_dir_name = "/nfs",
74 struct rpc_stat nfs_rpcstat = {
75 .program = &nfs_program
79 #ifdef CONFIG_NFS_V3_ACL
80 static struct rpc_stat nfsacl_rpcstat = { &nfsacl_program };
81 static struct rpc_version * nfsacl_version[] = {
82 [3] = &nfsacl_version3,
85 struct rpc_program nfsacl_program = {
86 .name = "nfsacl",
87 .number = NFS_ACL_PROGRAM,
88 .nrvers = ARRAY_SIZE(nfsacl_version),
89 .version = nfsacl_version,
90 .stats = &nfsacl_rpcstat,
92 #endif /* CONFIG_NFS_V3_ACL */
95 * Allocate a shared client record
97 * Since these are allocated/deallocated very rarely, we don't
98 * bother putting them in a slab cache...
100 static struct nfs_client *nfs_alloc_client(const char *hostname,
101 const struct sockaddr_in *addr,
102 int nfsversion)
104 struct nfs_client *clp;
106 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
107 goto error_0;
109 if (nfsversion == 4) {
110 if (nfs_callback_up() < 0)
111 goto error_2;
112 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
115 atomic_set(&clp->cl_count, 1);
116 clp->cl_cons_state = NFS_CS_INITING;
118 clp->cl_nfsversion = nfsversion;
119 memcpy(&clp->cl_addr, addr, sizeof(clp->cl_addr));
121 if (hostname) {
122 clp->cl_hostname = kstrdup(hostname, GFP_KERNEL);
123 if (!clp->cl_hostname)
124 goto error_3;
127 INIT_LIST_HEAD(&clp->cl_superblocks);
128 clp->cl_rpcclient = ERR_PTR(-EINVAL);
130 #ifdef CONFIG_NFS_V4
131 init_rwsem(&clp->cl_sem);
132 INIT_LIST_HEAD(&clp->cl_delegations);
133 spin_lock_init(&clp->cl_lock);
134 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
135 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
136 clp->cl_boot_time = CURRENT_TIME;
137 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
138 #endif
140 return clp;
142 error_3:
143 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
144 nfs_callback_down();
145 error_2:
146 kfree(clp);
147 error_0:
148 return NULL;
151 static void nfs4_shutdown_client(struct nfs_client *clp)
153 #ifdef CONFIG_NFS_V4
154 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
155 nfs4_kill_renewd(clp);
156 BUG_ON(!RB_EMPTY_ROOT(&clp->cl_state_owners));
157 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
158 nfs_idmap_delete(clp);
159 #endif
163 * Destroy a shared client record
165 static void nfs_free_client(struct nfs_client *clp)
167 dprintk("--> nfs_free_client(%d)\n", clp->cl_nfsversion);
169 nfs4_shutdown_client(clp);
171 /* -EIO all pending I/O */
172 if (!IS_ERR(clp->cl_rpcclient))
173 rpc_shutdown_client(clp->cl_rpcclient);
175 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
176 nfs_callback_down();
178 kfree(clp->cl_hostname);
179 kfree(clp);
181 dprintk("<-- nfs_free_client()\n");
185 * Release a reference to a shared client record
187 void nfs_put_client(struct nfs_client *clp)
189 if (!clp)
190 return;
192 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
194 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
195 list_del(&clp->cl_share_link);
196 spin_unlock(&nfs_client_lock);
198 BUG_ON(!list_empty(&clp->cl_superblocks));
200 nfs_free_client(clp);
205 * Find a client by address
206 * - caller must hold nfs_client_lock
208 static struct nfs_client *__nfs_find_client(const struct sockaddr_in *addr, int nfsversion, int match_port)
210 struct nfs_client *clp;
212 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
213 /* Don't match clients that failed to initialise properly */
214 if (clp->cl_cons_state < 0)
215 continue;
217 /* Different NFS versions cannot share the same nfs_client */
218 if (clp->cl_nfsversion != nfsversion)
219 continue;
221 if (memcmp(&clp->cl_addr.sin_addr, &addr->sin_addr,
222 sizeof(clp->cl_addr.sin_addr)) != 0)
223 continue;
225 if (!match_port || clp->cl_addr.sin_port == addr->sin_port)
226 goto found;
229 return NULL;
231 found:
232 atomic_inc(&clp->cl_count);
233 return clp;
237 * Find a client by IP address and protocol version
238 * - returns NULL if no such client
240 struct nfs_client *nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
242 struct nfs_client *clp;
244 spin_lock(&nfs_client_lock);
245 clp = __nfs_find_client(addr, nfsversion, 0);
246 spin_unlock(&nfs_client_lock);
247 if (clp != NULL && clp->cl_cons_state != NFS_CS_READY) {
248 nfs_put_client(clp);
249 clp = NULL;
251 return clp;
255 * Look up a client by IP address and protocol version
256 * - creates a new record if one doesn't yet exist
258 static struct nfs_client *nfs_get_client(const char *hostname,
259 const struct sockaddr_in *addr,
260 int nfsversion)
262 struct nfs_client *clp, *new = NULL;
263 int error;
265 dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT":%d,%d)\n",
266 hostname ?: "", NIPQUAD(addr->sin_addr),
267 addr->sin_port, nfsversion);
269 /* see if the client already exists */
270 do {
271 spin_lock(&nfs_client_lock);
273 clp = __nfs_find_client(addr, nfsversion, 1);
274 if (clp)
275 goto found_client;
276 if (new)
277 goto install_client;
279 spin_unlock(&nfs_client_lock);
281 new = nfs_alloc_client(hostname, addr, nfsversion);
282 } while (new);
284 return ERR_PTR(-ENOMEM);
286 /* install a new client and return with it unready */
287 install_client:
288 clp = new;
289 list_add(&clp->cl_share_link, &nfs_client_list);
290 spin_unlock(&nfs_client_lock);
291 dprintk("--> nfs_get_client() = %p [new]\n", clp);
292 return clp;
294 /* found an existing client
295 * - make sure it's ready before returning
297 found_client:
298 spin_unlock(&nfs_client_lock);
300 if (new)
301 nfs_free_client(new);
303 error = wait_event_interruptible(nfs_client_active_wq,
304 clp->cl_cons_state != NFS_CS_INITING);
305 if (error < 0) {
306 nfs_put_client(clp);
307 return ERR_PTR(-ERESTARTSYS);
310 if (clp->cl_cons_state < NFS_CS_READY) {
311 error = clp->cl_cons_state;
312 nfs_put_client(clp);
313 return ERR_PTR(error);
316 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
318 dprintk("--> nfs_get_client() = %p [share]\n", clp);
319 return clp;
323 * Mark a server as ready or failed
325 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
327 clp->cl_cons_state = state;
328 wake_up_all(&nfs_client_active_wq);
332 * Initialise the timeout values for a connection
334 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
335 unsigned int timeo, unsigned int retrans)
337 to->to_initval = timeo * HZ / 10;
338 to->to_retries = retrans;
339 if (!to->to_retries)
340 to->to_retries = 2;
342 switch (proto) {
343 case IPPROTO_TCP:
344 if (!to->to_initval)
345 to->to_initval = 60 * HZ;
346 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
347 to->to_initval = NFS_MAX_TCP_TIMEOUT;
348 to->to_increment = to->to_initval;
349 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
350 to->to_exponential = 0;
351 break;
352 case IPPROTO_UDP:
353 default:
354 if (!to->to_initval)
355 to->to_initval = 11 * HZ / 10;
356 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
357 to->to_initval = NFS_MAX_UDP_TIMEOUT;
358 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
359 to->to_exponential = 1;
360 break;
365 * Create an RPC client handle
367 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
368 unsigned int timeo,
369 unsigned int retrans,
370 rpc_authflavor_t flavor,
371 int flags)
373 struct rpc_timeout timeparms;
374 struct rpc_clnt *clnt = NULL;
375 struct rpc_create_args args = {
376 .protocol = proto,
377 .address = (struct sockaddr *)&clp->cl_addr,
378 .addrsize = sizeof(clp->cl_addr),
379 .timeout = &timeparms,
380 .servername = clp->cl_hostname,
381 .program = &nfs_program,
382 .version = clp->rpc_ops->version,
383 .authflavor = flavor,
384 .flags = flags,
387 if (!IS_ERR(clp->cl_rpcclient))
388 return 0;
390 nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
391 clp->retrans_timeo = timeparms.to_initval;
392 clp->retrans_count = timeparms.to_retries;
394 clnt = rpc_create(&args);
395 if (IS_ERR(clnt)) {
396 dprintk("%s: cannot create RPC client. Error = %ld\n",
397 __FUNCTION__, PTR_ERR(clnt));
398 return PTR_ERR(clnt);
401 clp->cl_rpcclient = clnt;
402 return 0;
406 * Version 2 or 3 client destruction
408 static void nfs_destroy_server(struct nfs_server *server)
410 if (!(server->flags & NFS_MOUNT_NONLM))
411 lockd_down(); /* release rpc.lockd */
415 * Version 2 or 3 lockd setup
417 static int nfs_start_lockd(struct nfs_server *server)
419 int error = 0;
421 if (server->nfs_client->cl_nfsversion > 3)
422 goto out;
423 if (server->flags & NFS_MOUNT_NONLM)
424 goto out;
425 error = lockd_up((server->flags & NFS_MOUNT_TCP) ?
426 IPPROTO_TCP : IPPROTO_UDP);
427 if (error < 0)
428 server->flags |= NFS_MOUNT_NONLM;
429 else
430 server->destroy = nfs_destroy_server;
431 out:
432 return error;
436 * Initialise an NFSv3 ACL client connection
438 #ifdef CONFIG_NFS_V3_ACL
439 static void nfs_init_server_aclclient(struct nfs_server *server)
441 if (server->nfs_client->cl_nfsversion != 3)
442 goto out_noacl;
443 if (server->flags & NFS_MOUNT_NOACL)
444 goto out_noacl;
446 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
447 if (IS_ERR(server->client_acl))
448 goto out_noacl;
450 /* No errors! Assume that Sun nfsacls are supported */
451 server->caps |= NFS_CAP_ACLS;
452 return;
454 out_noacl:
455 server->caps &= ~NFS_CAP_ACLS;
457 #else
458 static inline void nfs_init_server_aclclient(struct nfs_server *server)
460 server->flags &= ~NFS_MOUNT_NOACL;
461 server->caps &= ~NFS_CAP_ACLS;
463 #endif
466 * Create a general RPC client
468 static int nfs_init_server_rpcclient(struct nfs_server *server, rpc_authflavor_t pseudoflavour)
470 struct nfs_client *clp = server->nfs_client;
472 server->client = rpc_clone_client(clp->cl_rpcclient);
473 if (IS_ERR(server->client)) {
474 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
475 return PTR_ERR(server->client);
478 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
479 struct rpc_auth *auth;
481 auth = rpcauth_create(pseudoflavour, server->client);
482 if (IS_ERR(auth)) {
483 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
484 return PTR_ERR(auth);
487 server->client->cl_softrtry = 0;
488 if (server->flags & NFS_MOUNT_SOFT)
489 server->client->cl_softrtry = 1;
491 server->client->cl_intr = 0;
492 if (server->flags & NFS4_MOUNT_INTR)
493 server->client->cl_intr = 1;
495 return 0;
499 * Initialise an NFS2 or NFS3 client
501 static int nfs_init_client(struct nfs_client *clp, const struct nfs_mount_data *data)
503 int proto = (data->flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
504 int error;
506 if (clp->cl_cons_state == NFS_CS_READY) {
507 /* the client is already initialised */
508 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
509 return 0;
512 /* Check NFS protocol revision and initialize RPC op vector */
513 clp->rpc_ops = &nfs_v2_clientops;
514 #ifdef CONFIG_NFS_V3
515 if (clp->cl_nfsversion == 3)
516 clp->rpc_ops = &nfs_v3_clientops;
517 #endif
519 * Create a client RPC handle for doing FSSTAT with UNIX auth only
520 * - RFC 2623, sec 2.3.2
522 error = nfs_create_rpc_client(clp, proto, data->timeo, data->retrans,
523 RPC_AUTH_UNIX, 0);
524 if (error < 0)
525 goto error;
526 nfs_mark_client_ready(clp, NFS_CS_READY);
527 return 0;
529 error:
530 nfs_mark_client_ready(clp, error);
531 dprintk("<-- nfs_init_client() = xerror %d\n", error);
532 return error;
536 * Create a version 2 or 3 client
538 static int nfs_init_server(struct nfs_server *server, const struct nfs_mount_data *data)
540 struct nfs_client *clp;
541 int error, nfsvers = 2;
543 dprintk("--> nfs_init_server()\n");
545 #ifdef CONFIG_NFS_V3
546 if (data->flags & NFS_MOUNT_VER3)
547 nfsvers = 3;
548 #endif
550 /* Allocate or find a client reference we can use */
551 clp = nfs_get_client(data->hostname, &data->addr, nfsvers);
552 if (IS_ERR(clp)) {
553 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
554 return PTR_ERR(clp);
557 error = nfs_init_client(clp, data);
558 if (error < 0)
559 goto error;
561 server->nfs_client = clp;
563 /* Initialise the client representation from the mount data */
564 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
566 if (data->rsize)
567 server->rsize = nfs_block_size(data->rsize, NULL);
568 if (data->wsize)
569 server->wsize = nfs_block_size(data->wsize, NULL);
571 server->acregmin = data->acregmin * HZ;
572 server->acregmax = data->acregmax * HZ;
573 server->acdirmin = data->acdirmin * HZ;
574 server->acdirmax = data->acdirmax * HZ;
576 /* Start lockd here, before we might error out */
577 error = nfs_start_lockd(server);
578 if (error < 0)
579 goto error;
581 error = nfs_init_server_rpcclient(server, data->pseudoflavor);
582 if (error < 0)
583 goto error;
585 server->namelen = data->namlen;
586 /* Create a client RPC handle for the NFSv3 ACL management interface */
587 nfs_init_server_aclclient(server);
588 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
589 return 0;
591 error:
592 server->nfs_client = NULL;
593 nfs_put_client(clp);
594 dprintk("<-- nfs_init_server() = xerror %d\n", error);
595 return error;
599 * Load up the server record from information gained in an fsinfo record
601 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
603 unsigned long max_rpc_payload;
605 /* Work out a lot of parameters */
606 if (server->rsize == 0)
607 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
608 if (server->wsize == 0)
609 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
611 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
612 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
613 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
614 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
616 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
617 if (server->rsize > max_rpc_payload)
618 server->rsize = max_rpc_payload;
619 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
620 server->rsize = NFS_MAX_FILE_IO_SIZE;
621 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
622 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
624 if (server->wsize > max_rpc_payload)
625 server->wsize = max_rpc_payload;
626 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
627 server->wsize = NFS_MAX_FILE_IO_SIZE;
628 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
629 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
631 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
632 if (server->dtsize > PAGE_CACHE_SIZE)
633 server->dtsize = PAGE_CACHE_SIZE;
634 if (server->dtsize > server->rsize)
635 server->dtsize = server->rsize;
637 if (server->flags & NFS_MOUNT_NOAC) {
638 server->acregmin = server->acregmax = 0;
639 server->acdirmin = server->acdirmax = 0;
642 server->maxfilesize = fsinfo->maxfilesize;
644 /* We're airborne Set socket buffersize */
645 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
649 * Probe filesystem information, including the FSID on v2/v3
651 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
653 struct nfs_fsinfo fsinfo;
654 struct nfs_client *clp = server->nfs_client;
655 int error;
657 dprintk("--> nfs_probe_fsinfo()\n");
659 if (clp->rpc_ops->set_capabilities != NULL) {
660 error = clp->rpc_ops->set_capabilities(server, mntfh);
661 if (error < 0)
662 goto out_error;
665 fsinfo.fattr = fattr;
666 nfs_fattr_init(fattr);
667 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
668 if (error < 0)
669 goto out_error;
671 nfs_server_set_fsinfo(server, &fsinfo);
673 /* Get some general file system info */
674 if (server->namelen == 0) {
675 struct nfs_pathconf pathinfo;
677 pathinfo.fattr = fattr;
678 nfs_fattr_init(fattr);
680 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
681 server->namelen = pathinfo.max_namelen;
684 dprintk("<-- nfs_probe_fsinfo() = 0\n");
685 return 0;
687 out_error:
688 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
689 return error;
693 * Copy useful information when duplicating a server record
695 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
697 target->flags = source->flags;
698 target->acregmin = source->acregmin;
699 target->acregmax = source->acregmax;
700 target->acdirmin = source->acdirmin;
701 target->acdirmax = source->acdirmax;
702 target->caps = source->caps;
706 * Allocate and initialise a server record
708 static struct nfs_server *nfs_alloc_server(void)
710 struct nfs_server *server;
712 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
713 if (!server)
714 return NULL;
716 server->client = server->client_acl = ERR_PTR(-EINVAL);
718 /* Zero out the NFS state stuff */
719 INIT_LIST_HEAD(&server->client_link);
720 INIT_LIST_HEAD(&server->master_link);
722 server->io_stats = nfs_alloc_iostats();
723 if (!server->io_stats) {
724 kfree(server);
725 return NULL;
728 return server;
732 * Free up a server record
734 void nfs_free_server(struct nfs_server *server)
736 dprintk("--> nfs_free_server()\n");
738 spin_lock(&nfs_client_lock);
739 list_del(&server->client_link);
740 list_del(&server->master_link);
741 spin_unlock(&nfs_client_lock);
743 if (server->destroy != NULL)
744 server->destroy(server);
746 if (!IS_ERR(server->client_acl))
747 rpc_shutdown_client(server->client_acl);
748 if (!IS_ERR(server->client))
749 rpc_shutdown_client(server->client);
751 nfs_put_client(server->nfs_client);
753 nfs_free_iostats(server->io_stats);
754 kfree(server);
755 nfs_release_automount_timer();
756 dprintk("<-- nfs_free_server()\n");
760 * Create a version 2 or 3 volume record
761 * - keyed on server and FSID
763 struct nfs_server *nfs_create_server(const struct nfs_mount_data *data,
764 struct nfs_fh *mntfh)
766 struct nfs_server *server;
767 struct nfs_fattr fattr;
768 int error;
770 server = nfs_alloc_server();
771 if (!server)
772 return ERR_PTR(-ENOMEM);
774 /* Get a client representation */
775 error = nfs_init_server(server, data);
776 if (error < 0)
777 goto error;
779 BUG_ON(!server->nfs_client);
780 BUG_ON(!server->nfs_client->rpc_ops);
781 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
783 /* Probe the root fh to retrieve its FSID */
784 error = nfs_probe_fsinfo(server, mntfh, &fattr);
785 if (error < 0)
786 goto error;
787 if (server->nfs_client->rpc_ops->version == 3) {
788 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
789 server->namelen = NFS3_MAXNAMLEN;
790 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
791 server->caps |= NFS_CAP_READDIRPLUS;
792 } else {
793 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
794 server->namelen = NFS2_MAXNAMLEN;
797 if (!(fattr.valid & NFS_ATTR_FATTR)) {
798 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
799 if (error < 0) {
800 dprintk("nfs_create_server: getattr error = %d\n", -error);
801 goto error;
804 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
806 dprintk("Server FSID: %llx:%llx\n",
807 (unsigned long long) server->fsid.major,
808 (unsigned long long) server->fsid.minor);
810 BUG_ON(!server->nfs_client);
811 BUG_ON(!server->nfs_client->rpc_ops);
812 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
814 spin_lock(&nfs_client_lock);
815 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
816 list_add_tail(&server->master_link, &nfs_volume_list);
817 spin_unlock(&nfs_client_lock);
819 server->mount_time = jiffies;
820 return server;
822 error:
823 nfs_free_server(server);
824 return ERR_PTR(error);
827 #ifdef CONFIG_NFS_V4
829 * Initialise an NFS4 client record
831 static int nfs4_init_client(struct nfs_client *clp,
832 int proto, int timeo, int retrans,
833 const char *ip_addr,
834 rpc_authflavor_t authflavour)
836 int error;
838 if (clp->cl_cons_state == NFS_CS_READY) {
839 /* the client is initialised already */
840 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
841 return 0;
844 /* Check NFS protocol revision and initialize RPC op vector */
845 clp->rpc_ops = &nfs_v4_clientops;
847 error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour,
848 RPC_CLNT_CREATE_DISCRTRY);
849 if (error < 0)
850 goto error;
851 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
853 error = nfs_idmap_new(clp);
854 if (error < 0) {
855 dprintk("%s: failed to create idmapper. Error = %d\n",
856 __FUNCTION__, error);
857 goto error;
859 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
861 nfs_mark_client_ready(clp, NFS_CS_READY);
862 return 0;
864 error:
865 nfs_mark_client_ready(clp, error);
866 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
867 return error;
871 * Set up an NFS4 client
873 static int nfs4_set_client(struct nfs_server *server,
874 const char *hostname, const struct sockaddr_in *addr,
875 const char *ip_addr,
876 rpc_authflavor_t authflavour,
877 int proto, int timeo, int retrans)
879 struct nfs_client *clp;
880 int error;
882 dprintk("--> nfs4_set_client()\n");
884 /* Allocate or find a client reference we can use */
885 clp = nfs_get_client(hostname, addr, 4);
886 if (IS_ERR(clp)) {
887 error = PTR_ERR(clp);
888 goto error;
890 error = nfs4_init_client(clp, proto, timeo, retrans, ip_addr, authflavour);
891 if (error < 0)
892 goto error_put;
894 server->nfs_client = clp;
895 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
896 return 0;
898 error_put:
899 nfs_put_client(clp);
900 error:
901 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
902 return error;
906 * Create a version 4 volume record
908 static int nfs4_init_server(struct nfs_server *server,
909 const struct nfs4_mount_data *data, rpc_authflavor_t authflavour)
911 int error;
913 dprintk("--> nfs4_init_server()\n");
915 /* Initialise the client representation from the mount data */
916 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
917 server->caps |= NFS_CAP_ATOMIC_OPEN;
919 if (data->rsize)
920 server->rsize = nfs_block_size(data->rsize, NULL);
921 if (data->wsize)
922 server->wsize = nfs_block_size(data->wsize, NULL);
924 server->acregmin = data->acregmin * HZ;
925 server->acregmax = data->acregmax * HZ;
926 server->acdirmin = data->acdirmin * HZ;
927 server->acdirmax = data->acdirmax * HZ;
929 error = nfs_init_server_rpcclient(server, authflavour);
931 /* Done */
932 dprintk("<-- nfs4_init_server() = %d\n", error);
933 return error;
937 * Create a version 4 volume record
938 * - keyed on server and FSID
940 struct nfs_server *nfs4_create_server(const struct nfs4_mount_data *data,
941 const char *hostname,
942 const struct sockaddr_in *addr,
943 const char *mntpath,
944 const char *ip_addr,
945 rpc_authflavor_t authflavour,
946 struct nfs_fh *mntfh)
948 struct nfs_fattr fattr;
949 struct nfs_server *server;
950 int error;
952 dprintk("--> nfs4_create_server()\n");
954 server = nfs_alloc_server();
955 if (!server)
956 return ERR_PTR(-ENOMEM);
958 /* Get a client record */
959 error = nfs4_set_client(server, hostname, addr, ip_addr, authflavour,
960 data->proto, data->timeo, data->retrans);
961 if (error < 0)
962 goto error;
964 /* set up the general RPC client */
965 error = nfs4_init_server(server, data, authflavour);
966 if (error < 0)
967 goto error;
969 BUG_ON(!server->nfs_client);
970 BUG_ON(!server->nfs_client->rpc_ops);
971 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
973 /* Probe the root fh to retrieve its FSID */
974 error = nfs4_path_walk(server, mntfh, mntpath);
975 if (error < 0)
976 goto error;
978 dprintk("Server FSID: %llx:%llx\n",
979 (unsigned long long) server->fsid.major,
980 (unsigned long long) server->fsid.minor);
981 dprintk("Mount FH: %d\n", mntfh->size);
983 error = nfs_probe_fsinfo(server, mntfh, &fattr);
984 if (error < 0)
985 goto error;
987 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
988 server->namelen = NFS4_MAXNAMLEN;
990 BUG_ON(!server->nfs_client);
991 BUG_ON(!server->nfs_client->rpc_ops);
992 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
994 spin_lock(&nfs_client_lock);
995 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
996 list_add_tail(&server->master_link, &nfs_volume_list);
997 spin_unlock(&nfs_client_lock);
999 server->mount_time = jiffies;
1000 dprintk("<-- nfs4_create_server() = %p\n", server);
1001 return server;
1003 error:
1004 nfs_free_server(server);
1005 dprintk("<-- nfs4_create_server() = error %d\n", error);
1006 return ERR_PTR(error);
1010 * Create an NFS4 referral server record
1012 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1013 struct nfs_fh *mntfh)
1015 struct nfs_client *parent_client;
1016 struct nfs_server *server, *parent_server;
1017 struct nfs_fattr fattr;
1018 int error;
1020 dprintk("--> nfs4_create_referral_server()\n");
1022 server = nfs_alloc_server();
1023 if (!server)
1024 return ERR_PTR(-ENOMEM);
1026 parent_server = NFS_SB(data->sb);
1027 parent_client = parent_server->nfs_client;
1029 /* Get a client representation.
1030 * Note: NFSv4 always uses TCP, */
1031 error = nfs4_set_client(server, data->hostname, data->addr,
1032 parent_client->cl_ipaddr,
1033 data->authflavor,
1034 parent_server->client->cl_xprt->prot,
1035 parent_client->retrans_timeo,
1036 parent_client->retrans_count);
1037 if (error < 0)
1038 goto error;
1040 /* Initialise the client representation from the parent server */
1041 nfs_server_copy_userdata(server, parent_server);
1042 server->caps |= NFS_CAP_ATOMIC_OPEN;
1044 error = nfs_init_server_rpcclient(server, data->authflavor);
1045 if (error < 0)
1046 goto error;
1048 BUG_ON(!server->nfs_client);
1049 BUG_ON(!server->nfs_client->rpc_ops);
1050 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1052 /* Probe the root fh to retrieve its FSID and filehandle */
1053 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1054 if (error < 0)
1055 goto error;
1057 /* probe the filesystem info for this server filesystem */
1058 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1059 if (error < 0)
1060 goto error;
1062 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1063 server->namelen = NFS4_MAXNAMLEN;
1065 dprintk("Referral FSID: %llx:%llx\n",
1066 (unsigned long long) server->fsid.major,
1067 (unsigned long long) server->fsid.minor);
1069 spin_lock(&nfs_client_lock);
1070 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1071 list_add_tail(&server->master_link, &nfs_volume_list);
1072 spin_unlock(&nfs_client_lock);
1074 server->mount_time = jiffies;
1076 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1077 return server;
1079 error:
1080 nfs_free_server(server);
1081 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1082 return ERR_PTR(error);
1085 #endif /* CONFIG_NFS_V4 */
1088 * Clone an NFS2, NFS3 or NFS4 server record
1090 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1091 struct nfs_fh *fh,
1092 struct nfs_fattr *fattr)
1094 struct nfs_server *server;
1095 struct nfs_fattr fattr_fsinfo;
1096 int error;
1098 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1099 (unsigned long long) fattr->fsid.major,
1100 (unsigned long long) fattr->fsid.minor);
1102 server = nfs_alloc_server();
1103 if (!server)
1104 return ERR_PTR(-ENOMEM);
1106 /* Copy data from the source */
1107 server->nfs_client = source->nfs_client;
1108 atomic_inc(&server->nfs_client->cl_count);
1109 nfs_server_copy_userdata(server, source);
1111 server->fsid = fattr->fsid;
1113 error = nfs_init_server_rpcclient(server, source->client->cl_auth->au_flavor);
1114 if (error < 0)
1115 goto out_free_server;
1116 if (!IS_ERR(source->client_acl))
1117 nfs_init_server_aclclient(server);
1119 /* probe the filesystem info for this server filesystem */
1120 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1121 if (error < 0)
1122 goto out_free_server;
1124 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1125 server->namelen = NFS4_MAXNAMLEN;
1127 dprintk("Cloned FSID: %llx:%llx\n",
1128 (unsigned long long) server->fsid.major,
1129 (unsigned long long) server->fsid.minor);
1131 error = nfs_start_lockd(server);
1132 if (error < 0)
1133 goto out_free_server;
1135 spin_lock(&nfs_client_lock);
1136 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1137 list_add_tail(&server->master_link, &nfs_volume_list);
1138 spin_unlock(&nfs_client_lock);
1140 server->mount_time = jiffies;
1142 dprintk("<-- nfs_clone_server() = %p\n", server);
1143 return server;
1145 out_free_server:
1146 nfs_free_server(server);
1147 dprintk("<-- nfs_clone_server() = error %d\n", error);
1148 return ERR_PTR(error);
1151 #ifdef CONFIG_PROC_FS
1152 static struct proc_dir_entry *proc_fs_nfs;
1154 static int nfs_server_list_open(struct inode *inode, struct file *file);
1155 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1156 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1157 static void nfs_server_list_stop(struct seq_file *p, void *v);
1158 static int nfs_server_list_show(struct seq_file *m, void *v);
1160 static struct seq_operations nfs_server_list_ops = {
1161 .start = nfs_server_list_start,
1162 .next = nfs_server_list_next,
1163 .stop = nfs_server_list_stop,
1164 .show = nfs_server_list_show,
1167 static const struct file_operations nfs_server_list_fops = {
1168 .open = nfs_server_list_open,
1169 .read = seq_read,
1170 .llseek = seq_lseek,
1171 .release = seq_release,
1174 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1175 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1176 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1177 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1178 static int nfs_volume_list_show(struct seq_file *m, void *v);
1180 static struct seq_operations nfs_volume_list_ops = {
1181 .start = nfs_volume_list_start,
1182 .next = nfs_volume_list_next,
1183 .stop = nfs_volume_list_stop,
1184 .show = nfs_volume_list_show,
1187 static const struct file_operations nfs_volume_list_fops = {
1188 .open = nfs_volume_list_open,
1189 .read = seq_read,
1190 .llseek = seq_lseek,
1191 .release = seq_release,
1195 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1196 * we're dealing
1198 static int nfs_server_list_open(struct inode *inode, struct file *file)
1200 struct seq_file *m;
1201 int ret;
1203 ret = seq_open(file, &nfs_server_list_ops);
1204 if (ret < 0)
1205 return ret;
1207 m = file->private_data;
1208 m->private = PDE(inode)->data;
1210 return 0;
1214 * set up the iterator to start reading from the server list and return the first item
1216 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1218 struct list_head *_p;
1219 loff_t pos = *_pos;
1221 /* lock the list against modification */
1222 spin_lock(&nfs_client_lock);
1224 /* allow for the header line */
1225 if (!pos)
1226 return SEQ_START_TOKEN;
1227 pos--;
1229 /* find the n'th element in the list */
1230 list_for_each(_p, &nfs_client_list)
1231 if (!pos--)
1232 break;
1234 return _p != &nfs_client_list ? _p : NULL;
1238 * move to next server
1240 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1242 struct list_head *_p;
1244 (*pos)++;
1246 _p = v;
1247 _p = (v == SEQ_START_TOKEN) ? nfs_client_list.next : _p->next;
1249 return _p != &nfs_client_list ? _p : NULL;
1253 * clean up after reading from the transports list
1255 static void nfs_server_list_stop(struct seq_file *p, void *v)
1257 spin_unlock(&nfs_client_lock);
1261 * display a header line followed by a load of call lines
1263 static int nfs_server_list_show(struct seq_file *m, void *v)
1265 struct nfs_client *clp;
1267 /* display header on line 1 */
1268 if (v == SEQ_START_TOKEN) {
1269 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1270 return 0;
1273 /* display one transport per line on subsequent lines */
1274 clp = list_entry(v, struct nfs_client, cl_share_link);
1276 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %3d %s\n",
1277 clp->cl_nfsversion,
1278 NIPQUAD(clp->cl_addr.sin_addr),
1279 ntohs(clp->cl_addr.sin_port),
1280 atomic_read(&clp->cl_count),
1281 clp->cl_hostname);
1283 return 0;
1287 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1289 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1291 struct seq_file *m;
1292 int ret;
1294 ret = seq_open(file, &nfs_volume_list_ops);
1295 if (ret < 0)
1296 return ret;
1298 m = file->private_data;
1299 m->private = PDE(inode)->data;
1301 return 0;
1305 * set up the iterator to start reading from the volume list and return the first item
1307 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1309 struct list_head *_p;
1310 loff_t pos = *_pos;
1312 /* lock the list against modification */
1313 spin_lock(&nfs_client_lock);
1315 /* allow for the header line */
1316 if (!pos)
1317 return SEQ_START_TOKEN;
1318 pos--;
1320 /* find the n'th element in the list */
1321 list_for_each(_p, &nfs_volume_list)
1322 if (!pos--)
1323 break;
1325 return _p != &nfs_volume_list ? _p : NULL;
1329 * move to next volume
1331 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1333 struct list_head *_p;
1335 (*pos)++;
1337 _p = v;
1338 _p = (v == SEQ_START_TOKEN) ? nfs_volume_list.next : _p->next;
1340 return _p != &nfs_volume_list ? _p : NULL;
1344 * clean up after reading from the transports list
1346 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1348 spin_unlock(&nfs_client_lock);
1352 * display a header line followed by a load of call lines
1354 static int nfs_volume_list_show(struct seq_file *m, void *v)
1356 struct nfs_server *server;
1357 struct nfs_client *clp;
1358 char dev[8], fsid[17];
1360 /* display header on line 1 */
1361 if (v == SEQ_START_TOKEN) {
1362 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1363 return 0;
1365 /* display one transport per line on subsequent lines */
1366 server = list_entry(v, struct nfs_server, master_link);
1367 clp = server->nfs_client;
1369 snprintf(dev, 8, "%u:%u",
1370 MAJOR(server->s_dev), MINOR(server->s_dev));
1372 snprintf(fsid, 17, "%llx:%llx",
1373 (unsigned long long) server->fsid.major,
1374 (unsigned long long) server->fsid.minor);
1376 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %-7s %-17s\n",
1377 clp->cl_nfsversion,
1378 NIPQUAD(clp->cl_addr.sin_addr),
1379 ntohs(clp->cl_addr.sin_port),
1380 dev,
1381 fsid);
1383 return 0;
1387 * initialise the /proc/fs/nfsfs/ directory
1389 int __init nfs_fs_proc_init(void)
1391 struct proc_dir_entry *p;
1393 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1394 if (!proc_fs_nfs)
1395 goto error_0;
1397 proc_fs_nfs->owner = THIS_MODULE;
1399 /* a file of servers with which we're dealing */
1400 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1401 if (!p)
1402 goto error_1;
1404 p->proc_fops = &nfs_server_list_fops;
1405 p->owner = THIS_MODULE;
1407 /* a file of volumes that we have mounted */
1408 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1409 if (!p)
1410 goto error_2;
1412 p->proc_fops = &nfs_volume_list_fops;
1413 p->owner = THIS_MODULE;
1414 return 0;
1416 error_2:
1417 remove_proc_entry("servers", proc_fs_nfs);
1418 error_1:
1419 remove_proc_entry("nfsfs", proc_root_fs);
1420 error_0:
1421 return -ENOMEM;
1425 * clean up the /proc/fs/nfsfs/ directory
1427 void nfs_fs_proc_exit(void)
1429 remove_proc_entry("volumes", proc_fs_nfs);
1430 remove_proc_entry("servers", proc_fs_nfs);
1431 remove_proc_entry("nfsfs", proc_root_fs);
1434 #endif /* CONFIG_PROC_FS */