USB: option: fix usage of urb->status abuse
[linux-2.6/kmemtrace.git] / fs / nfs / client.c
blob881fa490092393c97ee5c69dd2cfe33e6bd9c3c0
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;
105 int error;
107 if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
108 goto error_0;
110 error = rpciod_up();
111 if (error < 0) {
112 dprintk("%s: couldn't start rpciod! Error = %d\n",
113 __FUNCTION__, error);
114 goto error_1;
116 __set_bit(NFS_CS_RPCIOD, &clp->cl_res_state);
118 if (nfsversion == 4) {
119 if (nfs_callback_up() < 0)
120 goto error_2;
121 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
124 atomic_set(&clp->cl_count, 1);
125 clp->cl_cons_state = NFS_CS_INITING;
127 clp->cl_nfsversion = nfsversion;
128 memcpy(&clp->cl_addr, addr, sizeof(clp->cl_addr));
130 if (hostname) {
131 clp->cl_hostname = kstrdup(hostname, GFP_KERNEL);
132 if (!clp->cl_hostname)
133 goto error_3;
136 INIT_LIST_HEAD(&clp->cl_superblocks);
137 clp->cl_rpcclient = ERR_PTR(-EINVAL);
139 #ifdef CONFIG_NFS_V4
140 init_rwsem(&clp->cl_sem);
141 INIT_LIST_HEAD(&clp->cl_delegations);
142 INIT_LIST_HEAD(&clp->cl_state_owners);
143 INIT_LIST_HEAD(&clp->cl_unused);
144 spin_lock_init(&clp->cl_lock);
145 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
146 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
147 clp->cl_boot_time = CURRENT_TIME;
148 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
149 #endif
151 return clp;
153 error_3:
154 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
155 nfs_callback_down();
156 error_2:
157 rpciod_down();
158 __clear_bit(NFS_CS_RPCIOD, &clp->cl_res_state);
159 error_1:
160 kfree(clp);
161 error_0:
162 return NULL;
165 static void nfs4_shutdown_client(struct nfs_client *clp)
167 #ifdef CONFIG_NFS_V4
168 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
169 nfs4_kill_renewd(clp);
170 while (!list_empty(&clp->cl_unused)) {
171 struct nfs4_state_owner *sp;
173 sp = list_entry(clp->cl_unused.next,
174 struct nfs4_state_owner,
175 so_list);
176 list_del(&sp->so_list);
177 kfree(sp);
179 BUG_ON(!list_empty(&clp->cl_state_owners));
180 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
181 nfs_idmap_delete(clp);
182 #endif
186 * Destroy a shared client record
188 static void nfs_free_client(struct nfs_client *clp)
190 dprintk("--> nfs_free_client(%d)\n", clp->cl_nfsversion);
192 nfs4_shutdown_client(clp);
194 /* -EIO all pending I/O */
195 if (!IS_ERR(clp->cl_rpcclient))
196 rpc_shutdown_client(clp->cl_rpcclient);
198 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
199 nfs_callback_down();
201 if (__test_and_clear_bit(NFS_CS_RPCIOD, &clp->cl_res_state))
202 rpciod_down();
204 kfree(clp->cl_hostname);
205 kfree(clp);
207 dprintk("<-- nfs_free_client()\n");
211 * Release a reference to a shared client record
213 void nfs_put_client(struct nfs_client *clp)
215 if (!clp)
216 return;
218 dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
220 if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
221 list_del(&clp->cl_share_link);
222 spin_unlock(&nfs_client_lock);
224 BUG_ON(!list_empty(&clp->cl_superblocks));
226 nfs_free_client(clp);
231 * Find a client by address
232 * - caller must hold nfs_client_lock
234 static struct nfs_client *__nfs_find_client(const struct sockaddr_in *addr, int nfsversion, int match_port)
236 struct nfs_client *clp;
238 list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
239 /* Don't match clients that failed to initialise properly */
240 if (clp->cl_cons_state < 0)
241 continue;
243 /* Different NFS versions cannot share the same nfs_client */
244 if (clp->cl_nfsversion != nfsversion)
245 continue;
247 if (memcmp(&clp->cl_addr.sin_addr, &addr->sin_addr,
248 sizeof(clp->cl_addr.sin_addr)) != 0)
249 continue;
251 if (!match_port || clp->cl_addr.sin_port == addr->sin_port)
252 goto found;
255 return NULL;
257 found:
258 atomic_inc(&clp->cl_count);
259 return clp;
263 * Find a client by IP address and protocol version
264 * - returns NULL if no such client
266 struct nfs_client *nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
268 struct nfs_client *clp;
270 spin_lock(&nfs_client_lock);
271 clp = __nfs_find_client(addr, nfsversion, 0);
272 spin_unlock(&nfs_client_lock);
273 if (clp != NULL && clp->cl_cons_state != NFS_CS_READY) {
274 nfs_put_client(clp);
275 clp = NULL;
277 return clp;
281 * Look up a client by IP address and protocol version
282 * - creates a new record if one doesn't yet exist
284 static struct nfs_client *nfs_get_client(const char *hostname,
285 const struct sockaddr_in *addr,
286 int nfsversion)
288 struct nfs_client *clp, *new = NULL;
289 int error;
291 dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT":%d,%d)\n",
292 hostname ?: "", NIPQUAD(addr->sin_addr),
293 addr->sin_port, nfsversion);
295 /* see if the client already exists */
296 do {
297 spin_lock(&nfs_client_lock);
299 clp = __nfs_find_client(addr, nfsversion, 1);
300 if (clp)
301 goto found_client;
302 if (new)
303 goto install_client;
305 spin_unlock(&nfs_client_lock);
307 new = nfs_alloc_client(hostname, addr, nfsversion);
308 } while (new);
310 return ERR_PTR(-ENOMEM);
312 /* install a new client and return with it unready */
313 install_client:
314 clp = new;
315 list_add(&clp->cl_share_link, &nfs_client_list);
316 spin_unlock(&nfs_client_lock);
317 dprintk("--> nfs_get_client() = %p [new]\n", clp);
318 return clp;
320 /* found an existing client
321 * - make sure it's ready before returning
323 found_client:
324 spin_unlock(&nfs_client_lock);
326 if (new)
327 nfs_free_client(new);
329 error = wait_event_interruptible(nfs_client_active_wq,
330 clp->cl_cons_state != NFS_CS_INITING);
331 if (error < 0) {
332 nfs_put_client(clp);
333 return ERR_PTR(-ERESTARTSYS);
336 if (clp->cl_cons_state < NFS_CS_READY) {
337 error = clp->cl_cons_state;
338 nfs_put_client(clp);
339 return ERR_PTR(error);
342 BUG_ON(clp->cl_cons_state != NFS_CS_READY);
344 dprintk("--> nfs_get_client() = %p [share]\n", clp);
345 return clp;
349 * Mark a server as ready or failed
351 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
353 clp->cl_cons_state = state;
354 wake_up_all(&nfs_client_active_wq);
358 * Initialise the timeout values for a connection
360 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
361 unsigned int timeo, unsigned int retrans)
363 to->to_initval = timeo * HZ / 10;
364 to->to_retries = retrans;
365 if (!to->to_retries)
366 to->to_retries = 2;
368 switch (proto) {
369 case IPPROTO_TCP:
370 if (!to->to_initval)
371 to->to_initval = 60 * HZ;
372 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
373 to->to_initval = NFS_MAX_TCP_TIMEOUT;
374 to->to_increment = to->to_initval;
375 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
376 to->to_exponential = 0;
377 break;
378 case IPPROTO_UDP:
379 default:
380 if (!to->to_initval)
381 to->to_initval = 11 * HZ / 10;
382 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
383 to->to_initval = NFS_MAX_UDP_TIMEOUT;
384 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
385 to->to_exponential = 1;
386 break;
391 * Create an RPC client handle
393 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
394 unsigned int timeo,
395 unsigned int retrans,
396 rpc_authflavor_t flavor,
397 int flags)
399 struct rpc_timeout timeparms;
400 struct rpc_clnt *clnt = NULL;
401 struct rpc_create_args args = {
402 .protocol = proto,
403 .address = (struct sockaddr *)&clp->cl_addr,
404 .addrsize = sizeof(clp->cl_addr),
405 .timeout = &timeparms,
406 .servername = clp->cl_hostname,
407 .program = &nfs_program,
408 .version = clp->rpc_ops->version,
409 .authflavor = flavor,
410 .flags = flags,
413 if (!IS_ERR(clp->cl_rpcclient))
414 return 0;
416 nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
417 clp->retrans_timeo = timeparms.to_initval;
418 clp->retrans_count = timeparms.to_retries;
420 clnt = rpc_create(&args);
421 if (IS_ERR(clnt)) {
422 dprintk("%s: cannot create RPC client. Error = %ld\n",
423 __FUNCTION__, PTR_ERR(clnt));
424 return PTR_ERR(clnt);
427 clp->cl_rpcclient = clnt;
428 return 0;
432 * Version 2 or 3 client destruction
434 static void nfs_destroy_server(struct nfs_server *server)
436 if (!IS_ERR(server->client_acl))
437 rpc_shutdown_client(server->client_acl);
439 if (!(server->flags & NFS_MOUNT_NONLM))
440 lockd_down(); /* release rpc.lockd */
444 * Version 2 or 3 lockd setup
446 static int nfs_start_lockd(struct nfs_server *server)
448 int error = 0;
450 if (server->nfs_client->cl_nfsversion > 3)
451 goto out;
452 if (server->flags & NFS_MOUNT_NONLM)
453 goto out;
454 error = lockd_up((server->flags & NFS_MOUNT_TCP) ?
455 IPPROTO_TCP : IPPROTO_UDP);
456 if (error < 0)
457 server->flags |= NFS_MOUNT_NONLM;
458 else
459 server->destroy = nfs_destroy_server;
460 out:
461 return error;
465 * Initialise an NFSv3 ACL client connection
467 #ifdef CONFIG_NFS_V3_ACL
468 static void nfs_init_server_aclclient(struct nfs_server *server)
470 if (server->nfs_client->cl_nfsversion != 3)
471 goto out_noacl;
472 if (server->flags & NFS_MOUNT_NOACL)
473 goto out_noacl;
475 server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
476 if (IS_ERR(server->client_acl))
477 goto out_noacl;
479 /* No errors! Assume that Sun nfsacls are supported */
480 server->caps |= NFS_CAP_ACLS;
481 return;
483 out_noacl:
484 server->caps &= ~NFS_CAP_ACLS;
486 #else
487 static inline void nfs_init_server_aclclient(struct nfs_server *server)
489 server->flags &= ~NFS_MOUNT_NOACL;
490 server->caps &= ~NFS_CAP_ACLS;
492 #endif
495 * Create a general RPC client
497 static int nfs_init_server_rpcclient(struct nfs_server *server, rpc_authflavor_t pseudoflavour)
499 struct nfs_client *clp = server->nfs_client;
501 server->client = rpc_clone_client(clp->cl_rpcclient);
502 if (IS_ERR(server->client)) {
503 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
504 return PTR_ERR(server->client);
507 if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
508 struct rpc_auth *auth;
510 auth = rpcauth_create(pseudoflavour, server->client);
511 if (IS_ERR(auth)) {
512 dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
513 return PTR_ERR(auth);
516 server->client->cl_softrtry = 0;
517 if (server->flags & NFS_MOUNT_SOFT)
518 server->client->cl_softrtry = 1;
520 server->client->cl_intr = 0;
521 if (server->flags & NFS4_MOUNT_INTR)
522 server->client->cl_intr = 1;
524 return 0;
528 * Initialise an NFS2 or NFS3 client
530 static int nfs_init_client(struct nfs_client *clp, const struct nfs_mount_data *data)
532 int proto = (data->flags & NFS_MOUNT_TCP) ? IPPROTO_TCP : IPPROTO_UDP;
533 int error;
535 if (clp->cl_cons_state == NFS_CS_READY) {
536 /* the client is already initialised */
537 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
538 return 0;
541 /* Check NFS protocol revision and initialize RPC op vector */
542 clp->rpc_ops = &nfs_v2_clientops;
543 #ifdef CONFIG_NFS_V3
544 if (clp->cl_nfsversion == 3)
545 clp->rpc_ops = &nfs_v3_clientops;
546 #endif
548 * Create a client RPC handle for doing FSSTAT with UNIX auth only
549 * - RFC 2623, sec 2.3.2
551 error = nfs_create_rpc_client(clp, proto, data->timeo, data->retrans,
552 RPC_AUTH_UNIX, 0);
553 if (error < 0)
554 goto error;
555 nfs_mark_client_ready(clp, NFS_CS_READY);
556 return 0;
558 error:
559 nfs_mark_client_ready(clp, error);
560 dprintk("<-- nfs_init_client() = xerror %d\n", error);
561 return error;
565 * Create a version 2 or 3 client
567 static int nfs_init_server(struct nfs_server *server, const struct nfs_mount_data *data)
569 struct nfs_client *clp;
570 int error, nfsvers = 2;
572 dprintk("--> nfs_init_server()\n");
574 #ifdef CONFIG_NFS_V3
575 if (data->flags & NFS_MOUNT_VER3)
576 nfsvers = 3;
577 #endif
579 /* Allocate or find a client reference we can use */
580 clp = nfs_get_client(data->hostname, &data->addr, nfsvers);
581 if (IS_ERR(clp)) {
582 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
583 return PTR_ERR(clp);
586 error = nfs_init_client(clp, data);
587 if (error < 0)
588 goto error;
590 server->nfs_client = clp;
592 /* Initialise the client representation from the mount data */
593 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
595 if (data->rsize)
596 server->rsize = nfs_block_size(data->rsize, NULL);
597 if (data->wsize)
598 server->wsize = nfs_block_size(data->wsize, NULL);
600 server->acregmin = data->acregmin * HZ;
601 server->acregmax = data->acregmax * HZ;
602 server->acdirmin = data->acdirmin * HZ;
603 server->acdirmax = data->acdirmax * HZ;
605 /* Start lockd here, before we might error out */
606 error = nfs_start_lockd(server);
607 if (error < 0)
608 goto error;
610 error = nfs_init_server_rpcclient(server, data->pseudoflavor);
611 if (error < 0)
612 goto error;
614 server->namelen = data->namlen;
615 /* Create a client RPC handle for the NFSv3 ACL management interface */
616 nfs_init_server_aclclient(server);
617 if (clp->cl_nfsversion == 3) {
618 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
619 server->namelen = NFS3_MAXNAMLEN;
620 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
621 server->caps |= NFS_CAP_READDIRPLUS;
622 } else {
623 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
624 server->namelen = NFS2_MAXNAMLEN;
627 dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
628 return 0;
630 error:
631 server->nfs_client = NULL;
632 nfs_put_client(clp);
633 dprintk("<-- nfs_init_server() = xerror %d\n", error);
634 return error;
638 * Load up the server record from information gained in an fsinfo record
640 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
642 unsigned long max_rpc_payload;
644 /* Work out a lot of parameters */
645 if (server->rsize == 0)
646 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
647 if (server->wsize == 0)
648 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
650 if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
651 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
652 if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
653 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
655 max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
656 if (server->rsize > max_rpc_payload)
657 server->rsize = max_rpc_payload;
658 if (server->rsize > NFS_MAX_FILE_IO_SIZE)
659 server->rsize = NFS_MAX_FILE_IO_SIZE;
660 server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
661 server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
663 if (server->wsize > max_rpc_payload)
664 server->wsize = max_rpc_payload;
665 if (server->wsize > NFS_MAX_FILE_IO_SIZE)
666 server->wsize = NFS_MAX_FILE_IO_SIZE;
667 server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
668 server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
670 server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
671 if (server->dtsize > PAGE_CACHE_SIZE)
672 server->dtsize = PAGE_CACHE_SIZE;
673 if (server->dtsize > server->rsize)
674 server->dtsize = server->rsize;
676 if (server->flags & NFS_MOUNT_NOAC) {
677 server->acregmin = server->acregmax = 0;
678 server->acdirmin = server->acdirmax = 0;
681 server->maxfilesize = fsinfo->maxfilesize;
683 /* We're airborne Set socket buffersize */
684 rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
688 * Probe filesystem information, including the FSID on v2/v3
690 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
692 struct nfs_fsinfo fsinfo;
693 struct nfs_client *clp = server->nfs_client;
694 int error;
696 dprintk("--> nfs_probe_fsinfo()\n");
698 if (clp->rpc_ops->set_capabilities != NULL) {
699 error = clp->rpc_ops->set_capabilities(server, mntfh);
700 if (error < 0)
701 goto out_error;
704 fsinfo.fattr = fattr;
705 nfs_fattr_init(fattr);
706 error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
707 if (error < 0)
708 goto out_error;
710 nfs_server_set_fsinfo(server, &fsinfo);
712 /* Get some general file system info */
713 if (server->namelen == 0) {
714 struct nfs_pathconf pathinfo;
716 pathinfo.fattr = fattr;
717 nfs_fattr_init(fattr);
719 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
720 server->namelen = pathinfo.max_namelen;
723 dprintk("<-- nfs_probe_fsinfo() = 0\n");
724 return 0;
726 out_error:
727 dprintk("nfs_probe_fsinfo: error = %d\n", -error);
728 return error;
732 * Copy useful information when duplicating a server record
734 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
736 target->flags = source->flags;
737 target->acregmin = source->acregmin;
738 target->acregmax = source->acregmax;
739 target->acdirmin = source->acdirmin;
740 target->acdirmax = source->acdirmax;
741 target->caps = source->caps;
745 * Allocate and initialise a server record
747 static struct nfs_server *nfs_alloc_server(void)
749 struct nfs_server *server;
751 server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
752 if (!server)
753 return NULL;
755 server->client = server->client_acl = ERR_PTR(-EINVAL);
757 /* Zero out the NFS state stuff */
758 INIT_LIST_HEAD(&server->client_link);
759 INIT_LIST_HEAD(&server->master_link);
761 server->io_stats = nfs_alloc_iostats();
762 if (!server->io_stats) {
763 kfree(server);
764 return NULL;
767 return server;
771 * Free up a server record
773 void nfs_free_server(struct nfs_server *server)
775 dprintk("--> nfs_free_server()\n");
777 spin_lock(&nfs_client_lock);
778 list_del(&server->client_link);
779 list_del(&server->master_link);
780 spin_unlock(&nfs_client_lock);
782 if (server->destroy != NULL)
783 server->destroy(server);
784 if (!IS_ERR(server->client))
785 rpc_shutdown_client(server->client);
787 nfs_put_client(server->nfs_client);
789 nfs_free_iostats(server->io_stats);
790 kfree(server);
791 nfs_release_automount_timer();
792 dprintk("<-- nfs_free_server()\n");
796 * Create a version 2 or 3 volume record
797 * - keyed on server and FSID
799 struct nfs_server *nfs_create_server(const struct nfs_mount_data *data,
800 struct nfs_fh *mntfh)
802 struct nfs_server *server;
803 struct nfs_fattr fattr;
804 int error;
806 server = nfs_alloc_server();
807 if (!server)
808 return ERR_PTR(-ENOMEM);
810 /* Get a client representation */
811 error = nfs_init_server(server, data);
812 if (error < 0)
813 goto error;
815 BUG_ON(!server->nfs_client);
816 BUG_ON(!server->nfs_client->rpc_ops);
817 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
819 /* Probe the root fh to retrieve its FSID */
820 error = nfs_probe_fsinfo(server, mntfh, &fattr);
821 if (error < 0)
822 goto error;
823 if (!(fattr.valid & NFS_ATTR_FATTR)) {
824 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
825 if (error < 0) {
826 dprintk("nfs_create_server: getattr error = %d\n", -error);
827 goto error;
830 memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
832 dprintk("Server FSID: %llx:%llx\n",
833 (unsigned long long) server->fsid.major,
834 (unsigned long long) server->fsid.minor);
836 BUG_ON(!server->nfs_client);
837 BUG_ON(!server->nfs_client->rpc_ops);
838 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
840 spin_lock(&nfs_client_lock);
841 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
842 list_add_tail(&server->master_link, &nfs_volume_list);
843 spin_unlock(&nfs_client_lock);
845 server->mount_time = jiffies;
846 return server;
848 error:
849 nfs_free_server(server);
850 return ERR_PTR(error);
853 #ifdef CONFIG_NFS_V4
855 * Initialise an NFS4 client record
857 static int nfs4_init_client(struct nfs_client *clp,
858 int proto, int timeo, int retrans,
859 const char *ip_addr,
860 rpc_authflavor_t authflavour)
862 int error;
864 if (clp->cl_cons_state == NFS_CS_READY) {
865 /* the client is initialised already */
866 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
867 return 0;
870 /* Check NFS protocol revision and initialize RPC op vector */
871 clp->rpc_ops = &nfs_v4_clientops;
873 error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour,
874 RPC_CLNT_CREATE_DISCRTRY);
875 if (error < 0)
876 goto error;
877 memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
879 error = nfs_idmap_new(clp);
880 if (error < 0) {
881 dprintk("%s: failed to create idmapper. Error = %d\n",
882 __FUNCTION__, error);
883 goto error;
885 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
887 nfs_mark_client_ready(clp, NFS_CS_READY);
888 return 0;
890 error:
891 nfs_mark_client_ready(clp, error);
892 dprintk("<-- nfs4_init_client() = xerror %d\n", error);
893 return error;
897 * Set up an NFS4 client
899 static int nfs4_set_client(struct nfs_server *server,
900 const char *hostname, const struct sockaddr_in *addr,
901 const char *ip_addr,
902 rpc_authflavor_t authflavour,
903 int proto, int timeo, int retrans)
905 struct nfs_client *clp;
906 int error;
908 dprintk("--> nfs4_set_client()\n");
910 /* Allocate or find a client reference we can use */
911 clp = nfs_get_client(hostname, addr, 4);
912 if (IS_ERR(clp)) {
913 error = PTR_ERR(clp);
914 goto error;
916 error = nfs4_init_client(clp, proto, timeo, retrans, ip_addr, authflavour);
917 if (error < 0)
918 goto error_put;
920 server->nfs_client = clp;
921 dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
922 return 0;
924 error_put:
925 nfs_put_client(clp);
926 error:
927 dprintk("<-- nfs4_set_client() = xerror %d\n", error);
928 return error;
932 * Create a version 4 volume record
934 static int nfs4_init_server(struct nfs_server *server,
935 const struct nfs4_mount_data *data, rpc_authflavor_t authflavour)
937 int error;
939 dprintk("--> nfs4_init_server()\n");
941 /* Initialise the client representation from the mount data */
942 server->flags = data->flags & NFS_MOUNT_FLAGMASK;
943 server->caps |= NFS_CAP_ATOMIC_OPEN;
945 if (data->rsize)
946 server->rsize = nfs_block_size(data->rsize, NULL);
947 if (data->wsize)
948 server->wsize = nfs_block_size(data->wsize, NULL);
950 server->acregmin = data->acregmin * HZ;
951 server->acregmax = data->acregmax * HZ;
952 server->acdirmin = data->acdirmin * HZ;
953 server->acdirmax = data->acdirmax * HZ;
955 error = nfs_init_server_rpcclient(server, authflavour);
957 /* Done */
958 dprintk("<-- nfs4_init_server() = %d\n", error);
959 return error;
963 * Create a version 4 volume record
964 * - keyed on server and FSID
966 struct nfs_server *nfs4_create_server(const struct nfs4_mount_data *data,
967 const char *hostname,
968 const struct sockaddr_in *addr,
969 const char *mntpath,
970 const char *ip_addr,
971 rpc_authflavor_t authflavour,
972 struct nfs_fh *mntfh)
974 struct nfs_fattr fattr;
975 struct nfs_server *server;
976 int error;
978 dprintk("--> nfs4_create_server()\n");
980 server = nfs_alloc_server();
981 if (!server)
982 return ERR_PTR(-ENOMEM);
984 /* Get a client record */
985 error = nfs4_set_client(server, hostname, addr, ip_addr, authflavour,
986 data->proto, data->timeo, data->retrans);
987 if (error < 0)
988 goto error;
990 /* set up the general RPC client */
991 error = nfs4_init_server(server, data, authflavour);
992 if (error < 0)
993 goto error;
995 BUG_ON(!server->nfs_client);
996 BUG_ON(!server->nfs_client->rpc_ops);
997 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
999 /* Probe the root fh to retrieve its FSID */
1000 error = nfs4_path_walk(server, mntfh, mntpath);
1001 if (error < 0)
1002 goto error;
1004 dprintk("Server FSID: %llx:%llx\n",
1005 (unsigned long long) server->fsid.major,
1006 (unsigned long long) server->fsid.minor);
1007 dprintk("Mount FH: %d\n", mntfh->size);
1009 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1010 if (error < 0)
1011 goto error;
1013 BUG_ON(!server->nfs_client);
1014 BUG_ON(!server->nfs_client->rpc_ops);
1015 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1017 spin_lock(&nfs_client_lock);
1018 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1019 list_add_tail(&server->master_link, &nfs_volume_list);
1020 spin_unlock(&nfs_client_lock);
1022 server->mount_time = jiffies;
1023 dprintk("<-- nfs4_create_server() = %p\n", server);
1024 return server;
1026 error:
1027 nfs_free_server(server);
1028 dprintk("<-- nfs4_create_server() = error %d\n", error);
1029 return ERR_PTR(error);
1033 * Create an NFS4 referral server record
1035 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1036 struct nfs_fh *mntfh)
1038 struct nfs_client *parent_client;
1039 struct nfs_server *server, *parent_server;
1040 struct nfs_fattr fattr;
1041 int error;
1043 dprintk("--> nfs4_create_referral_server()\n");
1045 server = nfs_alloc_server();
1046 if (!server)
1047 return ERR_PTR(-ENOMEM);
1049 parent_server = NFS_SB(data->sb);
1050 parent_client = parent_server->nfs_client;
1052 /* Get a client representation.
1053 * Note: NFSv4 always uses TCP, */
1054 error = nfs4_set_client(server, data->hostname, data->addr,
1055 parent_client->cl_ipaddr,
1056 data->authflavor,
1057 parent_server->client->cl_xprt->prot,
1058 parent_client->retrans_timeo,
1059 parent_client->retrans_count);
1060 if (error < 0)
1061 goto error;
1063 /* Initialise the client representation from the parent server */
1064 nfs_server_copy_userdata(server, parent_server);
1065 server->caps |= NFS_CAP_ATOMIC_OPEN;
1067 error = nfs_init_server_rpcclient(server, data->authflavor);
1068 if (error < 0)
1069 goto error;
1071 BUG_ON(!server->nfs_client);
1072 BUG_ON(!server->nfs_client->rpc_ops);
1073 BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1075 /* Probe the root fh to retrieve its FSID and filehandle */
1076 error = nfs4_path_walk(server, mntfh, data->mnt_path);
1077 if (error < 0)
1078 goto error;
1080 /* probe the filesystem info for this server filesystem */
1081 error = nfs_probe_fsinfo(server, mntfh, &fattr);
1082 if (error < 0)
1083 goto error;
1085 dprintk("Referral FSID: %llx:%llx\n",
1086 (unsigned long long) server->fsid.major,
1087 (unsigned long long) server->fsid.minor);
1089 spin_lock(&nfs_client_lock);
1090 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1091 list_add_tail(&server->master_link, &nfs_volume_list);
1092 spin_unlock(&nfs_client_lock);
1094 server->mount_time = jiffies;
1096 dprintk("<-- nfs_create_referral_server() = %p\n", server);
1097 return server;
1099 error:
1100 nfs_free_server(server);
1101 dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1102 return ERR_PTR(error);
1105 #endif /* CONFIG_NFS_V4 */
1108 * Clone an NFS2, NFS3 or NFS4 server record
1110 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1111 struct nfs_fh *fh,
1112 struct nfs_fattr *fattr)
1114 struct nfs_server *server;
1115 struct nfs_fattr fattr_fsinfo;
1116 int error;
1118 dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1119 (unsigned long long) fattr->fsid.major,
1120 (unsigned long long) fattr->fsid.minor);
1122 server = nfs_alloc_server();
1123 if (!server)
1124 return ERR_PTR(-ENOMEM);
1126 /* Copy data from the source */
1127 server->nfs_client = source->nfs_client;
1128 atomic_inc(&server->nfs_client->cl_count);
1129 nfs_server_copy_userdata(server, source);
1131 server->fsid = fattr->fsid;
1133 error = nfs_init_server_rpcclient(server, source->client->cl_auth->au_flavor);
1134 if (error < 0)
1135 goto out_free_server;
1136 if (!IS_ERR(source->client_acl))
1137 nfs_init_server_aclclient(server);
1139 /* probe the filesystem info for this server filesystem */
1140 error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1141 if (error < 0)
1142 goto out_free_server;
1144 dprintk("Cloned FSID: %llx:%llx\n",
1145 (unsigned long long) server->fsid.major,
1146 (unsigned long long) server->fsid.minor);
1148 error = nfs_start_lockd(server);
1149 if (error < 0)
1150 goto out_free_server;
1152 spin_lock(&nfs_client_lock);
1153 list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1154 list_add_tail(&server->master_link, &nfs_volume_list);
1155 spin_unlock(&nfs_client_lock);
1157 server->mount_time = jiffies;
1159 dprintk("<-- nfs_clone_server() = %p\n", server);
1160 return server;
1162 out_free_server:
1163 nfs_free_server(server);
1164 dprintk("<-- nfs_clone_server() = error %d\n", error);
1165 return ERR_PTR(error);
1168 #ifdef CONFIG_PROC_FS
1169 static struct proc_dir_entry *proc_fs_nfs;
1171 static int nfs_server_list_open(struct inode *inode, struct file *file);
1172 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1173 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1174 static void nfs_server_list_stop(struct seq_file *p, void *v);
1175 static int nfs_server_list_show(struct seq_file *m, void *v);
1177 static struct seq_operations nfs_server_list_ops = {
1178 .start = nfs_server_list_start,
1179 .next = nfs_server_list_next,
1180 .stop = nfs_server_list_stop,
1181 .show = nfs_server_list_show,
1184 static const struct file_operations nfs_server_list_fops = {
1185 .open = nfs_server_list_open,
1186 .read = seq_read,
1187 .llseek = seq_lseek,
1188 .release = seq_release,
1191 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1192 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1193 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1194 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1195 static int nfs_volume_list_show(struct seq_file *m, void *v);
1197 static struct seq_operations nfs_volume_list_ops = {
1198 .start = nfs_volume_list_start,
1199 .next = nfs_volume_list_next,
1200 .stop = nfs_volume_list_stop,
1201 .show = nfs_volume_list_show,
1204 static const struct file_operations nfs_volume_list_fops = {
1205 .open = nfs_volume_list_open,
1206 .read = seq_read,
1207 .llseek = seq_lseek,
1208 .release = seq_release,
1212 * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1213 * we're dealing
1215 static int nfs_server_list_open(struct inode *inode, struct file *file)
1217 struct seq_file *m;
1218 int ret;
1220 ret = seq_open(file, &nfs_server_list_ops);
1221 if (ret < 0)
1222 return ret;
1224 m = file->private_data;
1225 m->private = PDE(inode)->data;
1227 return 0;
1231 * set up the iterator to start reading from the server list and return the first item
1233 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1235 struct list_head *_p;
1236 loff_t pos = *_pos;
1238 /* lock the list against modification */
1239 spin_lock(&nfs_client_lock);
1241 /* allow for the header line */
1242 if (!pos)
1243 return SEQ_START_TOKEN;
1244 pos--;
1246 /* find the n'th element in the list */
1247 list_for_each(_p, &nfs_client_list)
1248 if (!pos--)
1249 break;
1251 return _p != &nfs_client_list ? _p : NULL;
1255 * move to next server
1257 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1259 struct list_head *_p;
1261 (*pos)++;
1263 _p = v;
1264 _p = (v == SEQ_START_TOKEN) ? nfs_client_list.next : _p->next;
1266 return _p != &nfs_client_list ? _p : NULL;
1270 * clean up after reading from the transports list
1272 static void nfs_server_list_stop(struct seq_file *p, void *v)
1274 spin_unlock(&nfs_client_lock);
1278 * display a header line followed by a load of call lines
1280 static int nfs_server_list_show(struct seq_file *m, void *v)
1282 struct nfs_client *clp;
1284 /* display header on line 1 */
1285 if (v == SEQ_START_TOKEN) {
1286 seq_puts(m, "NV SERVER PORT USE HOSTNAME\n");
1287 return 0;
1290 /* display one transport per line on subsequent lines */
1291 clp = list_entry(v, struct nfs_client, cl_share_link);
1293 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %3d %s\n",
1294 clp->cl_nfsversion,
1295 NIPQUAD(clp->cl_addr.sin_addr),
1296 ntohs(clp->cl_addr.sin_port),
1297 atomic_read(&clp->cl_count),
1298 clp->cl_hostname);
1300 return 0;
1304 * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1306 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1308 struct seq_file *m;
1309 int ret;
1311 ret = seq_open(file, &nfs_volume_list_ops);
1312 if (ret < 0)
1313 return ret;
1315 m = file->private_data;
1316 m->private = PDE(inode)->data;
1318 return 0;
1322 * set up the iterator to start reading from the volume list and return the first item
1324 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1326 struct list_head *_p;
1327 loff_t pos = *_pos;
1329 /* lock the list against modification */
1330 spin_lock(&nfs_client_lock);
1332 /* allow for the header line */
1333 if (!pos)
1334 return SEQ_START_TOKEN;
1335 pos--;
1337 /* find the n'th element in the list */
1338 list_for_each(_p, &nfs_volume_list)
1339 if (!pos--)
1340 break;
1342 return _p != &nfs_volume_list ? _p : NULL;
1346 * move to next volume
1348 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1350 struct list_head *_p;
1352 (*pos)++;
1354 _p = v;
1355 _p = (v == SEQ_START_TOKEN) ? nfs_volume_list.next : _p->next;
1357 return _p != &nfs_volume_list ? _p : NULL;
1361 * clean up after reading from the transports list
1363 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1365 spin_unlock(&nfs_client_lock);
1369 * display a header line followed by a load of call lines
1371 static int nfs_volume_list_show(struct seq_file *m, void *v)
1373 struct nfs_server *server;
1374 struct nfs_client *clp;
1375 char dev[8], fsid[17];
1377 /* display header on line 1 */
1378 if (v == SEQ_START_TOKEN) {
1379 seq_puts(m, "NV SERVER PORT DEV FSID\n");
1380 return 0;
1382 /* display one transport per line on subsequent lines */
1383 server = list_entry(v, struct nfs_server, master_link);
1384 clp = server->nfs_client;
1386 snprintf(dev, 8, "%u:%u",
1387 MAJOR(server->s_dev), MINOR(server->s_dev));
1389 snprintf(fsid, 17, "%llx:%llx",
1390 (unsigned long long) server->fsid.major,
1391 (unsigned long long) server->fsid.minor);
1393 seq_printf(m, "v%d %02x%02x%02x%02x %4hx %-7s %-17s\n",
1394 clp->cl_nfsversion,
1395 NIPQUAD(clp->cl_addr.sin_addr),
1396 ntohs(clp->cl_addr.sin_port),
1397 dev,
1398 fsid);
1400 return 0;
1404 * initialise the /proc/fs/nfsfs/ directory
1406 int __init nfs_fs_proc_init(void)
1408 struct proc_dir_entry *p;
1410 proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1411 if (!proc_fs_nfs)
1412 goto error_0;
1414 proc_fs_nfs->owner = THIS_MODULE;
1416 /* a file of servers with which we're dealing */
1417 p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1418 if (!p)
1419 goto error_1;
1421 p->proc_fops = &nfs_server_list_fops;
1422 p->owner = THIS_MODULE;
1424 /* a file of volumes that we have mounted */
1425 p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1426 if (!p)
1427 goto error_2;
1429 p->proc_fops = &nfs_volume_list_fops;
1430 p->owner = THIS_MODULE;
1431 return 0;
1433 error_2:
1434 remove_proc_entry("servers", proc_fs_nfs);
1435 error_1:
1436 remove_proc_entry("nfsfs", proc_root_fs);
1437 error_0:
1438 return -ENOMEM;
1442 * clean up the /proc/fs/nfsfs/ directory
1444 void nfs_fs_proc_exit(void)
1446 remove_proc_entry("volumes", proc_fs_nfs);
1447 remove_proc_entry("servers", proc_fs_nfs);
1448 remove_proc_entry("nfsfs", proc_root_fs);
1451 #endif /* CONFIG_PROC_FS */