NFS/SUNRPC: use transport protocol naming
[safe/jmp/linux-2.6] / fs / nfs / client.c
1 /* client.c: NFS client sharing and management code
2  *
3  * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
4  * Written by David Howells (dhowells@redhat.com)
5  *
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.
10  */
11
12
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/sunrpc/xprtsock.h>
27 #include <linux/nfs_fs.h>
28 #include <linux/nfs_mount.h>
29 #include <linux/nfs4_mount.h>
30 #include <linux/lockd/bind.h>
31 #include <linux/seq_file.h>
32 #include <linux/mount.h>
33 #include <linux/nfs_idmap.h>
34 #include <linux/vfs.h>
35 #include <linux/inet.h>
36 #include <linux/nfs_xdr.h>
37
38 #include <asm/system.h>
39
40 #include "nfs4_fs.h"
41 #include "callback.h"
42 #include "delegation.h"
43 #include "iostat.h"
44 #include "internal.h"
45
46 #define NFSDBG_FACILITY         NFSDBG_CLIENT
47
48 static DEFINE_SPINLOCK(nfs_client_lock);
49 static LIST_HEAD(nfs_client_list);
50 static LIST_HEAD(nfs_volume_list);
51 static DECLARE_WAIT_QUEUE_HEAD(nfs_client_active_wq);
52
53 /*
54  * RPC cruft for NFS
55  */
56 static struct rpc_version *nfs_version[5] = {
57         [2]                     = &nfs_version2,
58 #ifdef CONFIG_NFS_V3
59         [3]                     = &nfs_version3,
60 #endif
61 #ifdef CONFIG_NFS_V4
62         [4]                     = &nfs_version4,
63 #endif
64 };
65
66 struct rpc_program nfs_program = {
67         .name                   = "nfs",
68         .number                 = NFS_PROGRAM,
69         .nrvers                 = ARRAY_SIZE(nfs_version),
70         .version                = nfs_version,
71         .stats                  = &nfs_rpcstat,
72         .pipe_dir_name          = "/nfs",
73 };
74
75 struct rpc_stat nfs_rpcstat = {
76         .program                = &nfs_program
77 };
78
79
80 #ifdef CONFIG_NFS_V3_ACL
81 static struct rpc_stat          nfsacl_rpcstat = { &nfsacl_program };
82 static struct rpc_version *     nfsacl_version[] = {
83         [3]                     = &nfsacl_version3,
84 };
85
86 struct rpc_program              nfsacl_program = {
87         .name                   = "nfsacl",
88         .number                 = NFS_ACL_PROGRAM,
89         .nrvers                 = ARRAY_SIZE(nfsacl_version),
90         .version                = nfsacl_version,
91         .stats                  = &nfsacl_rpcstat,
92 };
93 #endif  /* CONFIG_NFS_V3_ACL */
94
95 /*
96  * Allocate a shared client record
97  *
98  * Since these are allocated/deallocated very rarely, we don't
99  * bother putting them in a slab cache...
100  */
101 static struct nfs_client *nfs_alloc_client(const char *hostname,
102                                            const struct sockaddr_in *addr,
103                                            int nfsversion)
104 {
105         struct nfs_client *clp;
106
107         if ((clp = kzalloc(sizeof(*clp), GFP_KERNEL)) == NULL)
108                 goto error_0;
109
110         if (nfsversion == 4) {
111                 if (nfs_callback_up() < 0)
112                         goto error_2;
113                 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
114         }
115
116         atomic_set(&clp->cl_count, 1);
117         clp->cl_cons_state = NFS_CS_INITING;
118
119         clp->cl_nfsversion = nfsversion;
120         memcpy(&clp->cl_addr, addr, sizeof(clp->cl_addr));
121
122         if (hostname) {
123                 clp->cl_hostname = kstrdup(hostname, GFP_KERNEL);
124                 if (!clp->cl_hostname)
125                         goto error_3;
126         }
127
128         INIT_LIST_HEAD(&clp->cl_superblocks);
129         clp->cl_rpcclient = ERR_PTR(-EINVAL);
130
131 #ifdef CONFIG_NFS_V4
132         init_rwsem(&clp->cl_sem);
133         INIT_LIST_HEAD(&clp->cl_delegations);
134         spin_lock_init(&clp->cl_lock);
135         INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
136         rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
137         clp->cl_boot_time = CURRENT_TIME;
138         clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
139 #endif
140
141         return clp;
142
143 error_3:
144         if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
145                 nfs_callback_down();
146 error_2:
147         kfree(clp);
148 error_0:
149         return NULL;
150 }
151
152 static void nfs4_shutdown_client(struct nfs_client *clp)
153 {
154 #ifdef CONFIG_NFS_V4
155         if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
156                 nfs4_kill_renewd(clp);
157         BUG_ON(!RB_EMPTY_ROOT(&clp->cl_state_owners));
158         if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
159                 nfs_idmap_delete(clp);
160 #endif
161 }
162
163 /*
164  * Destroy a shared client record
165  */
166 static void nfs_free_client(struct nfs_client *clp)
167 {
168         dprintk("--> nfs_free_client(%d)\n", clp->cl_nfsversion);
169
170         nfs4_shutdown_client(clp);
171
172         /* -EIO all pending I/O */
173         if (!IS_ERR(clp->cl_rpcclient))
174                 rpc_shutdown_client(clp->cl_rpcclient);
175
176         if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
177                 nfs_callback_down();
178
179         kfree(clp->cl_hostname);
180         kfree(clp);
181
182         dprintk("<-- nfs_free_client()\n");
183 }
184
185 /*
186  * Release a reference to a shared client record
187  */
188 void nfs_put_client(struct nfs_client *clp)
189 {
190         if (!clp)
191                 return;
192
193         dprintk("--> nfs_put_client({%d})\n", atomic_read(&clp->cl_count));
194
195         if (atomic_dec_and_lock(&clp->cl_count, &nfs_client_lock)) {
196                 list_del(&clp->cl_share_link);
197                 spin_unlock(&nfs_client_lock);
198
199                 BUG_ON(!list_empty(&clp->cl_superblocks));
200
201                 nfs_free_client(clp);
202         }
203 }
204
205 /*
206  * Find a client by address
207  * - caller must hold nfs_client_lock
208  */
209 static struct nfs_client *__nfs_find_client(const struct sockaddr_in *addr, int nfsversion, int match_port)
210 {
211         struct nfs_client *clp;
212
213         list_for_each_entry(clp, &nfs_client_list, cl_share_link) {
214                 /* Don't match clients that failed to initialise properly */
215                 if (clp->cl_cons_state < 0)
216                         continue;
217
218                 /* Different NFS versions cannot share the same nfs_client */
219                 if (clp->cl_nfsversion != nfsversion)
220                         continue;
221
222                 if (memcmp(&clp->cl_addr.sin_addr, &addr->sin_addr,
223                            sizeof(clp->cl_addr.sin_addr)) != 0)
224                         continue;
225
226                 if (!match_port || clp->cl_addr.sin_port == addr->sin_port)
227                         goto found;
228         }
229
230         return NULL;
231
232 found:
233         atomic_inc(&clp->cl_count);
234         return clp;
235 }
236
237 /*
238  * Find a client by IP address and protocol version
239  * - returns NULL if no such client
240  */
241 struct nfs_client *nfs_find_client(const struct sockaddr_in *addr, int nfsversion)
242 {
243         struct nfs_client *clp;
244
245         spin_lock(&nfs_client_lock);
246         clp = __nfs_find_client(addr, nfsversion, 0);
247         spin_unlock(&nfs_client_lock);
248         if (clp != NULL && clp->cl_cons_state != NFS_CS_READY) {
249                 nfs_put_client(clp);
250                 clp = NULL;
251         }
252         return clp;
253 }
254
255 /*
256  * Look up a client by IP address and protocol version
257  * - creates a new record if one doesn't yet exist
258  */
259 static struct nfs_client *nfs_get_client(const char *hostname,
260                                          const struct sockaddr_in *addr,
261                                          int nfsversion)
262 {
263         struct nfs_client *clp, *new = NULL;
264         int error;
265
266         dprintk("--> nfs_get_client(%s,"NIPQUAD_FMT":%d,%d)\n",
267                 hostname ?: "", NIPQUAD(addr->sin_addr),
268                 addr->sin_port, nfsversion);
269
270         /* see if the client already exists */
271         do {
272                 spin_lock(&nfs_client_lock);
273
274                 clp = __nfs_find_client(addr, nfsversion, 1);
275                 if (clp)
276                         goto found_client;
277                 if (new)
278                         goto install_client;
279
280                 spin_unlock(&nfs_client_lock);
281
282                 new = nfs_alloc_client(hostname, addr, nfsversion);
283         } while (new);
284
285         return ERR_PTR(-ENOMEM);
286
287         /* install a new client and return with it unready */
288 install_client:
289         clp = new;
290         list_add(&clp->cl_share_link, &nfs_client_list);
291         spin_unlock(&nfs_client_lock);
292         dprintk("--> nfs_get_client() = %p [new]\n", clp);
293         return clp;
294
295         /* found an existing client
296          * - make sure it's ready before returning
297          */
298 found_client:
299         spin_unlock(&nfs_client_lock);
300
301         if (new)
302                 nfs_free_client(new);
303
304         error = wait_event_interruptible(nfs_client_active_wq,
305                                 clp->cl_cons_state != NFS_CS_INITING);
306         if (error < 0) {
307                 nfs_put_client(clp);
308                 return ERR_PTR(-ERESTARTSYS);
309         }
310
311         if (clp->cl_cons_state < NFS_CS_READY) {
312                 error = clp->cl_cons_state;
313                 nfs_put_client(clp);
314                 return ERR_PTR(error);
315         }
316
317         BUG_ON(clp->cl_cons_state != NFS_CS_READY);
318
319         dprintk("--> nfs_get_client() = %p [share]\n", clp);
320         return clp;
321 }
322
323 /*
324  * Mark a server as ready or failed
325  */
326 static void nfs_mark_client_ready(struct nfs_client *clp, int state)
327 {
328         clp->cl_cons_state = state;
329         wake_up_all(&nfs_client_active_wq);
330 }
331
332 /*
333  * Initialise the timeout values for a connection
334  */
335 static void nfs_init_timeout_values(struct rpc_timeout *to, int proto,
336                                     unsigned int timeo, unsigned int retrans)
337 {
338         to->to_initval = timeo * HZ / 10;
339         to->to_retries = retrans;
340         if (!to->to_retries)
341                 to->to_retries = 2;
342
343         switch (proto) {
344         case XPRT_TRANSPORT_TCP:
345                 if (!to->to_initval)
346                         to->to_initval = 60 * HZ;
347                 if (to->to_initval > NFS_MAX_TCP_TIMEOUT)
348                         to->to_initval = NFS_MAX_TCP_TIMEOUT;
349                 to->to_increment = to->to_initval;
350                 to->to_maxval = to->to_initval + (to->to_increment * to->to_retries);
351                 to->to_exponential = 0;
352                 break;
353         case XPRT_TRANSPORT_UDP:
354         default:
355                 if (!to->to_initval)
356                         to->to_initval = 11 * HZ / 10;
357                 if (to->to_initval > NFS_MAX_UDP_TIMEOUT)
358                         to->to_initval = NFS_MAX_UDP_TIMEOUT;
359                 to->to_maxval = NFS_MAX_UDP_TIMEOUT;
360                 to->to_exponential = 1;
361                 break;
362         }
363 }
364
365 /*
366  * Create an RPC client handle
367  */
368 static int nfs_create_rpc_client(struct nfs_client *clp, int proto,
369                                                 unsigned int timeo,
370                                                 unsigned int retrans,
371                                                 rpc_authflavor_t flavor,
372                                                 int flags)
373 {
374         struct rpc_timeout      timeparms;
375         struct rpc_clnt         *clnt = NULL;
376         struct rpc_create_args args = {
377                 .protocol       = proto,
378                 .address        = (struct sockaddr *)&clp->cl_addr,
379                 .addrsize       = sizeof(clp->cl_addr),
380                 .timeout        = &timeparms,
381                 .servername     = clp->cl_hostname,
382                 .program        = &nfs_program,
383                 .version        = clp->rpc_ops->version,
384                 .authflavor     = flavor,
385                 .flags          = flags,
386         };
387
388         if (!IS_ERR(clp->cl_rpcclient))
389                 return 0;
390
391         nfs_init_timeout_values(&timeparms, proto, timeo, retrans);
392         clp->retrans_timeo = timeparms.to_initval;
393         clp->retrans_count = timeparms.to_retries;
394
395         clnt = rpc_create(&args);
396         if (IS_ERR(clnt)) {
397                 dprintk("%s: cannot create RPC client. Error = %ld\n",
398                                 __FUNCTION__, PTR_ERR(clnt));
399                 return PTR_ERR(clnt);
400         }
401
402         clp->cl_rpcclient = clnt;
403         return 0;
404 }
405
406 /*
407  * Version 2 or 3 client destruction
408  */
409 static void nfs_destroy_server(struct nfs_server *server)
410 {
411         if (!IS_ERR(server->client_acl))
412                 rpc_shutdown_client(server->client_acl);
413
414         if (!(server->flags & NFS_MOUNT_NONLM))
415                 lockd_down();   /* release rpc.lockd */
416 }
417
418 /*
419  * Version 2 or 3 lockd setup
420  */
421 static int nfs_start_lockd(struct nfs_server *server)
422 {
423         int error = 0;
424
425         if (server->nfs_client->cl_nfsversion > 3)
426                 goto out;
427         if (server->flags & NFS_MOUNT_NONLM)
428                 goto out;
429         error = lockd_up((server->flags & NFS_MOUNT_TCP) ?
430                         IPPROTO_TCP : IPPROTO_UDP);
431         if (error < 0)
432                 server->flags |= NFS_MOUNT_NONLM;
433         else
434                 server->destroy = nfs_destroy_server;
435 out:
436         return error;
437 }
438
439 /*
440  * Initialise an NFSv3 ACL client connection
441  */
442 #ifdef CONFIG_NFS_V3_ACL
443 static void nfs_init_server_aclclient(struct nfs_server *server)
444 {
445         if (server->nfs_client->cl_nfsversion != 3)
446                 goto out_noacl;
447         if (server->flags & NFS_MOUNT_NOACL)
448                 goto out_noacl;
449
450         server->client_acl = rpc_bind_new_program(server->client, &nfsacl_program, 3);
451         if (IS_ERR(server->client_acl))
452                 goto out_noacl;
453
454         /* No errors! Assume that Sun nfsacls are supported */
455         server->caps |= NFS_CAP_ACLS;
456         return;
457
458 out_noacl:
459         server->caps &= ~NFS_CAP_ACLS;
460 }
461 #else
462 static inline void nfs_init_server_aclclient(struct nfs_server *server)
463 {
464         server->flags &= ~NFS_MOUNT_NOACL;
465         server->caps &= ~NFS_CAP_ACLS;
466 }
467 #endif
468
469 /*
470  * Create a general RPC client
471  */
472 static int nfs_init_server_rpcclient(struct nfs_server *server, rpc_authflavor_t pseudoflavour)
473 {
474         struct nfs_client *clp = server->nfs_client;
475
476         server->client = rpc_clone_client(clp->cl_rpcclient);
477         if (IS_ERR(server->client)) {
478                 dprintk("%s: couldn't create rpc_client!\n", __FUNCTION__);
479                 return PTR_ERR(server->client);
480         }
481
482         if (pseudoflavour != clp->cl_rpcclient->cl_auth->au_flavor) {
483                 struct rpc_auth *auth;
484
485                 auth = rpcauth_create(pseudoflavour, server->client);
486                 if (IS_ERR(auth)) {
487                         dprintk("%s: couldn't create credcache!\n", __FUNCTION__);
488                         return PTR_ERR(auth);
489                 }
490         }
491         server->client->cl_softrtry = 0;
492         if (server->flags & NFS_MOUNT_SOFT)
493                 server->client->cl_softrtry = 1;
494
495         server->client->cl_intr = 0;
496         if (server->flags & NFS4_MOUNT_INTR)
497                 server->client->cl_intr = 1;
498
499         return 0;
500 }
501
502 /*
503  * Initialise an NFS2 or NFS3 client
504  */
505 static int nfs_init_client(struct nfs_client *clp,
506                            const struct nfs_parsed_mount_data *data)
507 {
508         int error;
509
510         if (clp->cl_cons_state == NFS_CS_READY) {
511                 /* the client is already initialised */
512                 dprintk("<-- nfs_init_client() = 0 [already %p]\n", clp);
513                 return 0;
514         }
515
516         /* Check NFS protocol revision and initialize RPC op vector */
517         clp->rpc_ops = &nfs_v2_clientops;
518 #ifdef CONFIG_NFS_V3
519         if (clp->cl_nfsversion == 3)
520                 clp->rpc_ops = &nfs_v3_clientops;
521 #endif
522         /*
523          * Create a client RPC handle for doing FSSTAT with UNIX auth only
524          * - RFC 2623, sec 2.3.2
525          */
526         error = nfs_create_rpc_client(clp, data->nfs_server.protocol,
527                                 data->timeo, data->retrans, RPC_AUTH_UNIX, 0);
528         if (error < 0)
529                 goto error;
530         nfs_mark_client_ready(clp, NFS_CS_READY);
531         return 0;
532
533 error:
534         nfs_mark_client_ready(clp, error);
535         dprintk("<-- nfs_init_client() = xerror %d\n", error);
536         return error;
537 }
538
539 /*
540  * Create a version 2 or 3 client
541  */
542 static int nfs_init_server(struct nfs_server *server,
543                            const struct nfs_parsed_mount_data *data)
544 {
545         struct nfs_client *clp;
546         int error, nfsvers = 2;
547
548         dprintk("--> nfs_init_server()\n");
549
550 #ifdef CONFIG_NFS_V3
551         if (data->flags & NFS_MOUNT_VER3)
552                 nfsvers = 3;
553 #endif
554
555         /* Allocate or find a client reference we can use */
556         clp = nfs_get_client(data->nfs_server.hostname,
557                                 &data->nfs_server.address, nfsvers);
558         if (IS_ERR(clp)) {
559                 dprintk("<-- nfs_init_server() = error %ld\n", PTR_ERR(clp));
560                 return PTR_ERR(clp);
561         }
562
563         error = nfs_init_client(clp, data);
564         if (error < 0)
565                 goto error;
566
567         server->nfs_client = clp;
568
569         /* Initialise the client representation from the mount data */
570         server->flags = data->flags & NFS_MOUNT_FLAGMASK;
571
572         if (data->rsize)
573                 server->rsize = nfs_block_size(data->rsize, NULL);
574         if (data->wsize)
575                 server->wsize = nfs_block_size(data->wsize, NULL);
576
577         server->acregmin = data->acregmin * HZ;
578         server->acregmax = data->acregmax * HZ;
579         server->acdirmin = data->acdirmin * HZ;
580         server->acdirmax = data->acdirmax * HZ;
581
582         /* Start lockd here, before we might error out */
583         error = nfs_start_lockd(server);
584         if (error < 0)
585                 goto error;
586
587         error = nfs_init_server_rpcclient(server, data->auth_flavors[0]);
588         if (error < 0)
589                 goto error;
590
591         server->namelen  = data->namlen;
592         /* Create a client RPC handle for the NFSv3 ACL management interface */
593         nfs_init_server_aclclient(server);
594         dprintk("<-- nfs_init_server() = 0 [new %p]\n", clp);
595         return 0;
596
597 error:
598         server->nfs_client = NULL;
599         nfs_put_client(clp);
600         dprintk("<-- nfs_init_server() = xerror %d\n", error);
601         return error;
602 }
603
604 /*
605  * Load up the server record from information gained in an fsinfo record
606  */
607 static void nfs_server_set_fsinfo(struct nfs_server *server, struct nfs_fsinfo *fsinfo)
608 {
609         unsigned long max_rpc_payload;
610
611         /* Work out a lot of parameters */
612         if (server->rsize == 0)
613                 server->rsize = nfs_block_size(fsinfo->rtpref, NULL);
614         if (server->wsize == 0)
615                 server->wsize = nfs_block_size(fsinfo->wtpref, NULL);
616
617         if (fsinfo->rtmax >= 512 && server->rsize > fsinfo->rtmax)
618                 server->rsize = nfs_block_size(fsinfo->rtmax, NULL);
619         if (fsinfo->wtmax >= 512 && server->wsize > fsinfo->wtmax)
620                 server->wsize = nfs_block_size(fsinfo->wtmax, NULL);
621
622         max_rpc_payload = nfs_block_size(rpc_max_payload(server->client), NULL);
623         if (server->rsize > max_rpc_payload)
624                 server->rsize = max_rpc_payload;
625         if (server->rsize > NFS_MAX_FILE_IO_SIZE)
626                 server->rsize = NFS_MAX_FILE_IO_SIZE;
627         server->rpages = (server->rsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
628         server->backing_dev_info.ra_pages = server->rpages * NFS_MAX_READAHEAD;
629
630         if (server->wsize > max_rpc_payload)
631                 server->wsize = max_rpc_payload;
632         if (server->wsize > NFS_MAX_FILE_IO_SIZE)
633                 server->wsize = NFS_MAX_FILE_IO_SIZE;
634         server->wpages = (server->wsize + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
635         server->wtmult = nfs_block_bits(fsinfo->wtmult, NULL);
636
637         server->dtsize = nfs_block_size(fsinfo->dtpref, NULL);
638         if (server->dtsize > PAGE_CACHE_SIZE)
639                 server->dtsize = PAGE_CACHE_SIZE;
640         if (server->dtsize > server->rsize)
641                 server->dtsize = server->rsize;
642
643         if (server->flags & NFS_MOUNT_NOAC) {
644                 server->acregmin = server->acregmax = 0;
645                 server->acdirmin = server->acdirmax = 0;
646         }
647
648         server->maxfilesize = fsinfo->maxfilesize;
649
650         /* We're airborne Set socket buffersize */
651         rpc_setbufsize(server->client, server->wsize + 100, server->rsize + 100);
652 }
653
654 /*
655  * Probe filesystem information, including the FSID on v2/v3
656  */
657 static int nfs_probe_fsinfo(struct nfs_server *server, struct nfs_fh *mntfh, struct nfs_fattr *fattr)
658 {
659         struct nfs_fsinfo fsinfo;
660         struct nfs_client *clp = server->nfs_client;
661         int error;
662
663         dprintk("--> nfs_probe_fsinfo()\n");
664
665         if (clp->rpc_ops->set_capabilities != NULL) {
666                 error = clp->rpc_ops->set_capabilities(server, mntfh);
667                 if (error < 0)
668                         goto out_error;
669         }
670
671         fsinfo.fattr = fattr;
672         nfs_fattr_init(fattr);
673         error = clp->rpc_ops->fsinfo(server, mntfh, &fsinfo);
674         if (error < 0)
675                 goto out_error;
676
677         nfs_server_set_fsinfo(server, &fsinfo);
678
679         /* Get some general file system info */
680         if (server->namelen == 0) {
681                 struct nfs_pathconf pathinfo;
682
683                 pathinfo.fattr = fattr;
684                 nfs_fattr_init(fattr);
685
686                 if (clp->rpc_ops->pathconf(server, mntfh, &pathinfo) >= 0)
687                         server->namelen = pathinfo.max_namelen;
688         }
689
690         dprintk("<-- nfs_probe_fsinfo() = 0\n");
691         return 0;
692
693 out_error:
694         dprintk("nfs_probe_fsinfo: error = %d\n", -error);
695         return error;
696 }
697
698 /*
699  * Copy useful information when duplicating a server record
700  */
701 static void nfs_server_copy_userdata(struct nfs_server *target, struct nfs_server *source)
702 {
703         target->flags = source->flags;
704         target->acregmin = source->acregmin;
705         target->acregmax = source->acregmax;
706         target->acdirmin = source->acdirmin;
707         target->acdirmax = source->acdirmax;
708         target->caps = source->caps;
709 }
710
711 /*
712  * Allocate and initialise a server record
713  */
714 static struct nfs_server *nfs_alloc_server(void)
715 {
716         struct nfs_server *server;
717
718         server = kzalloc(sizeof(struct nfs_server), GFP_KERNEL);
719         if (!server)
720                 return NULL;
721
722         server->client = server->client_acl = ERR_PTR(-EINVAL);
723
724         /* Zero out the NFS state stuff */
725         INIT_LIST_HEAD(&server->client_link);
726         INIT_LIST_HEAD(&server->master_link);
727
728         server->io_stats = nfs_alloc_iostats();
729         if (!server->io_stats) {
730                 kfree(server);
731                 return NULL;
732         }
733
734         return server;
735 }
736
737 /*
738  * Free up a server record
739  */
740 void nfs_free_server(struct nfs_server *server)
741 {
742         dprintk("--> nfs_free_server()\n");
743
744         spin_lock(&nfs_client_lock);
745         list_del(&server->client_link);
746         list_del(&server->master_link);
747         spin_unlock(&nfs_client_lock);
748
749         if (server->destroy != NULL)
750                 server->destroy(server);
751         if (!IS_ERR(server->client))
752                 rpc_shutdown_client(server->client);
753
754         nfs_put_client(server->nfs_client);
755
756         nfs_free_iostats(server->io_stats);
757         kfree(server);
758         nfs_release_automount_timer();
759         dprintk("<-- nfs_free_server()\n");
760 }
761
762 /*
763  * Create a version 2 or 3 volume record
764  * - keyed on server and FSID
765  */
766 struct nfs_server *nfs_create_server(const struct nfs_parsed_mount_data *data,
767                                      struct nfs_fh *mntfh)
768 {
769         struct nfs_server *server;
770         struct nfs_fattr fattr;
771         int error;
772
773         server = nfs_alloc_server();
774         if (!server)
775                 return ERR_PTR(-ENOMEM);
776
777         /* Get a client representation */
778         error = nfs_init_server(server, data);
779         if (error < 0)
780                 goto error;
781
782         BUG_ON(!server->nfs_client);
783         BUG_ON(!server->nfs_client->rpc_ops);
784         BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
785
786         /* Probe the root fh to retrieve its FSID */
787         error = nfs_probe_fsinfo(server, mntfh, &fattr);
788         if (error < 0)
789                 goto error;
790         if (server->nfs_client->rpc_ops->version == 3) {
791                 if (server->namelen == 0 || server->namelen > NFS3_MAXNAMLEN)
792                         server->namelen = NFS3_MAXNAMLEN;
793                 if (!(data->flags & NFS_MOUNT_NORDIRPLUS))
794                         server->caps |= NFS_CAP_READDIRPLUS;
795         } else {
796                 if (server->namelen == 0 || server->namelen > NFS2_MAXNAMLEN)
797                         server->namelen = NFS2_MAXNAMLEN;
798         }
799
800         if (!(fattr.valid & NFS_ATTR_FATTR)) {
801                 error = server->nfs_client->rpc_ops->getattr(server, mntfh, &fattr);
802                 if (error < 0) {
803                         dprintk("nfs_create_server: getattr error = %d\n", -error);
804                         goto error;
805                 }
806         }
807         memcpy(&server->fsid, &fattr.fsid, sizeof(server->fsid));
808
809         dprintk("Server FSID: %llx:%llx\n",
810                 (unsigned long long) server->fsid.major,
811                 (unsigned long long) server->fsid.minor);
812
813         BUG_ON(!server->nfs_client);
814         BUG_ON(!server->nfs_client->rpc_ops);
815         BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
816
817         spin_lock(&nfs_client_lock);
818         list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
819         list_add_tail(&server->master_link, &nfs_volume_list);
820         spin_unlock(&nfs_client_lock);
821
822         server->mount_time = jiffies;
823         return server;
824
825 error:
826         nfs_free_server(server);
827         return ERR_PTR(error);
828 }
829
830 #ifdef CONFIG_NFS_V4
831 /*
832  * Initialise an NFS4 client record
833  */
834 static int nfs4_init_client(struct nfs_client *clp,
835                 int proto, int timeo, int retrans,
836                 const char *ip_addr,
837                 rpc_authflavor_t authflavour)
838 {
839         int error;
840
841         if (clp->cl_cons_state == NFS_CS_READY) {
842                 /* the client is initialised already */
843                 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
844                 return 0;
845         }
846
847         /* Check NFS protocol revision and initialize RPC op vector */
848         clp->rpc_ops = &nfs_v4_clientops;
849
850         error = nfs_create_rpc_client(clp, proto, timeo, retrans, authflavour,
851                                         RPC_CLNT_CREATE_DISCRTRY);
852         if (error < 0)
853                 goto error;
854         memcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
855
856         error = nfs_idmap_new(clp);
857         if (error < 0) {
858                 dprintk("%s: failed to create idmapper. Error = %d\n",
859                         __FUNCTION__, error);
860                 goto error;
861         }
862         __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
863
864         nfs_mark_client_ready(clp, NFS_CS_READY);
865         return 0;
866
867 error:
868         nfs_mark_client_ready(clp, error);
869         dprintk("<-- nfs4_init_client() = xerror %d\n", error);
870         return error;
871 }
872
873 /*
874  * Set up an NFS4 client
875  */
876 static int nfs4_set_client(struct nfs_server *server,
877                 const char *hostname, const struct sockaddr_in *addr,
878                 const char *ip_addr,
879                 rpc_authflavor_t authflavour,
880                 int proto, int timeo, int retrans)
881 {
882         struct nfs_client *clp;
883         int error;
884
885         dprintk("--> nfs4_set_client()\n");
886
887         /* Allocate or find a client reference we can use */
888         clp = nfs_get_client(hostname, addr, 4);
889         if (IS_ERR(clp)) {
890                 error = PTR_ERR(clp);
891                 goto error;
892         }
893         error = nfs4_init_client(clp, proto, timeo, retrans, ip_addr, authflavour);
894         if (error < 0)
895                 goto error_put;
896
897         server->nfs_client = clp;
898         dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
899         return 0;
900
901 error_put:
902         nfs_put_client(clp);
903 error:
904         dprintk("<-- nfs4_set_client() = xerror %d\n", error);
905         return error;
906 }
907
908 /*
909  * Create a version 4 volume record
910  */
911 static int nfs4_init_server(struct nfs_server *server,
912                 const struct nfs_parsed_mount_data *data)
913 {
914         int error;
915
916         dprintk("--> nfs4_init_server()\n");
917
918         /* Initialise the client representation from the mount data */
919         server->flags = data->flags & NFS_MOUNT_FLAGMASK;
920         server->caps |= NFS_CAP_ATOMIC_OPEN;
921
922         if (data->rsize)
923                 server->rsize = nfs_block_size(data->rsize, NULL);
924         if (data->wsize)
925                 server->wsize = nfs_block_size(data->wsize, NULL);
926
927         server->acregmin = data->acregmin * HZ;
928         server->acregmax = data->acregmax * HZ;
929         server->acdirmin = data->acdirmin * HZ;
930         server->acdirmax = data->acdirmax * HZ;
931
932         error = nfs_init_server_rpcclient(server, data->auth_flavors[0]);
933
934         /* Done */
935         dprintk("<-- nfs4_init_server() = %d\n", error);
936         return error;
937 }
938
939 /*
940  * Create a version 4 volume record
941  * - keyed on server and FSID
942  */
943 struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
944                                       struct nfs_fh *mntfh)
945 {
946         struct nfs_fattr fattr;
947         struct nfs_server *server;
948         int error;
949
950         dprintk("--> nfs4_create_server()\n");
951
952         server = nfs_alloc_server();
953         if (!server)
954                 return ERR_PTR(-ENOMEM);
955
956         /* Get a client record */
957         error = nfs4_set_client(server,
958                         data->nfs_server.hostname,
959                         &data->nfs_server.address,
960                         data->client_address,
961                         data->auth_flavors[0],
962                         data->nfs_server.protocol,
963                         data->timeo, data->retrans);
964         if (error < 0)
965                 goto error;
966
967         /* set up the general RPC client */
968         error = nfs4_init_server(server, data);
969         if (error < 0)
970                 goto error;
971
972         BUG_ON(!server->nfs_client);
973         BUG_ON(!server->nfs_client->rpc_ops);
974         BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
975
976         /* Probe the root fh to retrieve its FSID */
977         error = nfs4_path_walk(server, mntfh, data->nfs_server.export_path);
978         if (error < 0)
979                 goto error;
980
981         dprintk("Server FSID: %llx:%llx\n",
982                 (unsigned long long) server->fsid.major,
983                 (unsigned long long) server->fsid.minor);
984         dprintk("Mount FH: %d\n", mntfh->size);
985
986         error = nfs_probe_fsinfo(server, mntfh, &fattr);
987         if (error < 0)
988                 goto error;
989
990         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
991                 server->namelen = NFS4_MAXNAMLEN;
992
993         BUG_ON(!server->nfs_client);
994         BUG_ON(!server->nfs_client->rpc_ops);
995         BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
996
997         spin_lock(&nfs_client_lock);
998         list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
999         list_add_tail(&server->master_link, &nfs_volume_list);
1000         spin_unlock(&nfs_client_lock);
1001
1002         server->mount_time = jiffies;
1003         dprintk("<-- nfs4_create_server() = %p\n", server);
1004         return server;
1005
1006 error:
1007         nfs_free_server(server);
1008         dprintk("<-- nfs4_create_server() = error %d\n", error);
1009         return ERR_PTR(error);
1010 }
1011
1012 /*
1013  * Create an NFS4 referral server record
1014  */
1015 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1016                                                struct nfs_fh *mntfh)
1017 {
1018         struct nfs_client *parent_client;
1019         struct nfs_server *server, *parent_server;
1020         struct nfs_fattr fattr;
1021         int error;
1022
1023         dprintk("--> nfs4_create_referral_server()\n");
1024
1025         server = nfs_alloc_server();
1026         if (!server)
1027                 return ERR_PTR(-ENOMEM);
1028
1029         parent_server = NFS_SB(data->sb);
1030         parent_client = parent_server->nfs_client;
1031
1032         /* Get a client representation.
1033          * Note: NFSv4 always uses TCP, */
1034         error = nfs4_set_client(server, data->hostname, data->addr,
1035                         parent_client->cl_ipaddr,
1036                         data->authflavor,
1037                         parent_server->client->cl_xprt->prot,
1038                         parent_client->retrans_timeo,
1039                         parent_client->retrans_count);
1040         if (error < 0)
1041                 goto error;
1042
1043         /* Initialise the client representation from the parent server */
1044         nfs_server_copy_userdata(server, parent_server);
1045         server->caps |= NFS_CAP_ATOMIC_OPEN;
1046
1047         error = nfs_init_server_rpcclient(server, data->authflavor);
1048         if (error < 0)
1049                 goto error;
1050
1051         BUG_ON(!server->nfs_client);
1052         BUG_ON(!server->nfs_client->rpc_ops);
1053         BUG_ON(!server->nfs_client->rpc_ops->file_inode_ops);
1054
1055         /* Probe the root fh to retrieve its FSID and filehandle */
1056         error = nfs4_path_walk(server, mntfh, data->mnt_path);
1057         if (error < 0)
1058                 goto error;
1059
1060         /* probe the filesystem info for this server filesystem */
1061         error = nfs_probe_fsinfo(server, mntfh, &fattr);
1062         if (error < 0)
1063                 goto error;
1064
1065         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1066                 server->namelen = NFS4_MAXNAMLEN;
1067
1068         dprintk("Referral FSID: %llx:%llx\n",
1069                 (unsigned long long) server->fsid.major,
1070                 (unsigned long long) server->fsid.minor);
1071
1072         spin_lock(&nfs_client_lock);
1073         list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1074         list_add_tail(&server->master_link, &nfs_volume_list);
1075         spin_unlock(&nfs_client_lock);
1076
1077         server->mount_time = jiffies;
1078
1079         dprintk("<-- nfs_create_referral_server() = %p\n", server);
1080         return server;
1081
1082 error:
1083         nfs_free_server(server);
1084         dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1085         return ERR_PTR(error);
1086 }
1087
1088 #endif /* CONFIG_NFS_V4 */
1089
1090 /*
1091  * Clone an NFS2, NFS3 or NFS4 server record
1092  */
1093 struct nfs_server *nfs_clone_server(struct nfs_server *source,
1094                                     struct nfs_fh *fh,
1095                                     struct nfs_fattr *fattr)
1096 {
1097         struct nfs_server *server;
1098         struct nfs_fattr fattr_fsinfo;
1099         int error;
1100
1101         dprintk("--> nfs_clone_server(,%llx:%llx,)\n",
1102                 (unsigned long long) fattr->fsid.major,
1103                 (unsigned long long) fattr->fsid.minor);
1104
1105         server = nfs_alloc_server();
1106         if (!server)
1107                 return ERR_PTR(-ENOMEM);
1108
1109         /* Copy data from the source */
1110         server->nfs_client = source->nfs_client;
1111         atomic_inc(&server->nfs_client->cl_count);
1112         nfs_server_copy_userdata(server, source);
1113
1114         server->fsid = fattr->fsid;
1115
1116         error = nfs_init_server_rpcclient(server, source->client->cl_auth->au_flavor);
1117         if (error < 0)
1118                 goto out_free_server;
1119         if (!IS_ERR(source->client_acl))
1120                 nfs_init_server_aclclient(server);
1121
1122         /* probe the filesystem info for this server filesystem */
1123         error = nfs_probe_fsinfo(server, fh, &fattr_fsinfo);
1124         if (error < 0)
1125                 goto out_free_server;
1126
1127         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1128                 server->namelen = NFS4_MAXNAMLEN;
1129
1130         dprintk("Cloned FSID: %llx:%llx\n",
1131                 (unsigned long long) server->fsid.major,
1132                 (unsigned long long) server->fsid.minor);
1133
1134         error = nfs_start_lockd(server);
1135         if (error < 0)
1136                 goto out_free_server;
1137
1138         spin_lock(&nfs_client_lock);
1139         list_add_tail(&server->client_link, &server->nfs_client->cl_superblocks);
1140         list_add_tail(&server->master_link, &nfs_volume_list);
1141         spin_unlock(&nfs_client_lock);
1142
1143         server->mount_time = jiffies;
1144
1145         dprintk("<-- nfs_clone_server() = %p\n", server);
1146         return server;
1147
1148 out_free_server:
1149         nfs_free_server(server);
1150         dprintk("<-- nfs_clone_server() = error %d\n", error);
1151         return ERR_PTR(error);
1152 }
1153
1154 #ifdef CONFIG_PROC_FS
1155 static struct proc_dir_entry *proc_fs_nfs;
1156
1157 static int nfs_server_list_open(struct inode *inode, struct file *file);
1158 static void *nfs_server_list_start(struct seq_file *p, loff_t *pos);
1159 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos);
1160 static void nfs_server_list_stop(struct seq_file *p, void *v);
1161 static int nfs_server_list_show(struct seq_file *m, void *v);
1162
1163 static struct seq_operations nfs_server_list_ops = {
1164         .start  = nfs_server_list_start,
1165         .next   = nfs_server_list_next,
1166         .stop   = nfs_server_list_stop,
1167         .show   = nfs_server_list_show,
1168 };
1169
1170 static const struct file_operations nfs_server_list_fops = {
1171         .open           = nfs_server_list_open,
1172         .read           = seq_read,
1173         .llseek         = seq_lseek,
1174         .release        = seq_release,
1175 };
1176
1177 static int nfs_volume_list_open(struct inode *inode, struct file *file);
1178 static void *nfs_volume_list_start(struct seq_file *p, loff_t *pos);
1179 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos);
1180 static void nfs_volume_list_stop(struct seq_file *p, void *v);
1181 static int nfs_volume_list_show(struct seq_file *m, void *v);
1182
1183 static struct seq_operations nfs_volume_list_ops = {
1184         .start  = nfs_volume_list_start,
1185         .next   = nfs_volume_list_next,
1186         .stop   = nfs_volume_list_stop,
1187         .show   = nfs_volume_list_show,
1188 };
1189
1190 static const struct file_operations nfs_volume_list_fops = {
1191         .open           = nfs_volume_list_open,
1192         .read           = seq_read,
1193         .llseek         = seq_lseek,
1194         .release        = seq_release,
1195 };
1196
1197 /*
1198  * open "/proc/fs/nfsfs/servers" which provides a summary of servers with which
1199  * we're dealing
1200  */
1201 static int nfs_server_list_open(struct inode *inode, struct file *file)
1202 {
1203         struct seq_file *m;
1204         int ret;
1205
1206         ret = seq_open(file, &nfs_server_list_ops);
1207         if (ret < 0)
1208                 return ret;
1209
1210         m = file->private_data;
1211         m->private = PDE(inode)->data;
1212
1213         return 0;
1214 }
1215
1216 /*
1217  * set up the iterator to start reading from the server list and return the first item
1218  */
1219 static void *nfs_server_list_start(struct seq_file *m, loff_t *_pos)
1220 {
1221         /* lock the list against modification */
1222         spin_lock(&nfs_client_lock);
1223         return seq_list_start_head(&nfs_client_list, *_pos);
1224 }
1225
1226 /*
1227  * move to next server
1228  */
1229 static void *nfs_server_list_next(struct seq_file *p, void *v, loff_t *pos)
1230 {
1231         return seq_list_next(v, &nfs_client_list, pos);
1232 }
1233
1234 /*
1235  * clean up after reading from the transports list
1236  */
1237 static void nfs_server_list_stop(struct seq_file *p, void *v)
1238 {
1239         spin_unlock(&nfs_client_lock);
1240 }
1241
1242 /*
1243  * display a header line followed by a load of call lines
1244  */
1245 static int nfs_server_list_show(struct seq_file *m, void *v)
1246 {
1247         struct nfs_client *clp;
1248
1249         /* display header on line 1 */
1250         if (v == &nfs_client_list) {
1251                 seq_puts(m, "NV SERVER   PORT USE HOSTNAME\n");
1252                 return 0;
1253         }
1254
1255         /* display one transport per line on subsequent lines */
1256         clp = list_entry(v, struct nfs_client, cl_share_link);
1257
1258         seq_printf(m, "v%d %02x%02x%02x%02x %4hx %3d %s\n",
1259                    clp->cl_nfsversion,
1260                    NIPQUAD(clp->cl_addr.sin_addr),
1261                    ntohs(clp->cl_addr.sin_port),
1262                    atomic_read(&clp->cl_count),
1263                    clp->cl_hostname);
1264
1265         return 0;
1266 }
1267
1268 /*
1269  * open "/proc/fs/nfsfs/volumes" which provides a summary of extant volumes
1270  */
1271 static int nfs_volume_list_open(struct inode *inode, struct file *file)
1272 {
1273         struct seq_file *m;
1274         int ret;
1275
1276         ret = seq_open(file, &nfs_volume_list_ops);
1277         if (ret < 0)
1278                 return ret;
1279
1280         m = file->private_data;
1281         m->private = PDE(inode)->data;
1282
1283         return 0;
1284 }
1285
1286 /*
1287  * set up the iterator to start reading from the volume list and return the first item
1288  */
1289 static void *nfs_volume_list_start(struct seq_file *m, loff_t *_pos)
1290 {
1291         /* lock the list against modification */
1292         spin_lock(&nfs_client_lock);
1293         return seq_list_start_head(&nfs_volume_list, *_pos);
1294 }
1295
1296 /*
1297  * move to next volume
1298  */
1299 static void *nfs_volume_list_next(struct seq_file *p, void *v, loff_t *pos)
1300 {
1301         return seq_list_next(v, &nfs_volume_list, pos);
1302 }
1303
1304 /*
1305  * clean up after reading from the transports list
1306  */
1307 static void nfs_volume_list_stop(struct seq_file *p, void *v)
1308 {
1309         spin_unlock(&nfs_client_lock);
1310 }
1311
1312 /*
1313  * display a header line followed by a load of call lines
1314  */
1315 static int nfs_volume_list_show(struct seq_file *m, void *v)
1316 {
1317         struct nfs_server *server;
1318         struct nfs_client *clp;
1319         char dev[8], fsid[17];
1320
1321         /* display header on line 1 */
1322         if (v == &nfs_volume_list) {
1323                 seq_puts(m, "NV SERVER   PORT DEV     FSID\n");
1324                 return 0;
1325         }
1326         /* display one transport per line on subsequent lines */
1327         server = list_entry(v, struct nfs_server, master_link);
1328         clp = server->nfs_client;
1329
1330         snprintf(dev, 8, "%u:%u",
1331                  MAJOR(server->s_dev), MINOR(server->s_dev));
1332
1333         snprintf(fsid, 17, "%llx:%llx",
1334                  (unsigned long long) server->fsid.major,
1335                  (unsigned long long) server->fsid.minor);
1336
1337         seq_printf(m, "v%d %02x%02x%02x%02x %4hx %-7s %-17s\n",
1338                    clp->cl_nfsversion,
1339                    NIPQUAD(clp->cl_addr.sin_addr),
1340                    ntohs(clp->cl_addr.sin_port),
1341                    dev,
1342                    fsid);
1343
1344         return 0;
1345 }
1346
1347 /*
1348  * initialise the /proc/fs/nfsfs/ directory
1349  */
1350 int __init nfs_fs_proc_init(void)
1351 {
1352         struct proc_dir_entry *p;
1353
1354         proc_fs_nfs = proc_mkdir("nfsfs", proc_root_fs);
1355         if (!proc_fs_nfs)
1356                 goto error_0;
1357
1358         proc_fs_nfs->owner = THIS_MODULE;
1359
1360         /* a file of servers with which we're dealing */
1361         p = create_proc_entry("servers", S_IFREG|S_IRUGO, proc_fs_nfs);
1362         if (!p)
1363                 goto error_1;
1364
1365         p->proc_fops = &nfs_server_list_fops;
1366         p->owner = THIS_MODULE;
1367
1368         /* a file of volumes that we have mounted */
1369         p = create_proc_entry("volumes", S_IFREG|S_IRUGO, proc_fs_nfs);
1370         if (!p)
1371                 goto error_2;
1372
1373         p->proc_fops = &nfs_volume_list_fops;
1374         p->owner = THIS_MODULE;
1375         return 0;
1376
1377 error_2:
1378         remove_proc_entry("servers", proc_fs_nfs);
1379 error_1:
1380         remove_proc_entry("nfsfs", proc_root_fs);
1381 error_0:
1382         return -ENOMEM;
1383 }
1384
1385 /*
1386  * clean up the /proc/fs/nfsfs/ directory
1387  */
1388 void nfs_fs_proc_exit(void)
1389 {
1390         remove_proc_entry("volumes", proc_fs_nfs);
1391         remove_proc_entry("servers", proc_fs_nfs);
1392         remove_proc_entry("nfsfs", proc_root_fs);
1393 }
1394
1395 #endif /* CONFIG_PROC_FS */