]> Pileus Git - ~andy/linux/blob - fs/nfs/nfs4client.c
Merge tag 'nfs-for-3.14-1' of git://git.linux-nfs.org/projects/trondmy/linux-nfs
[~andy/linux] / fs / nfs / nfs4client.c
1 /*
2  * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
3  * Written by David Howells (dhowells@redhat.com)
4  */
5 #include <linux/module.h>
6 #include <linux/nfs_fs.h>
7 #include <linux/nfs_idmap.h>
8 #include <linux/nfs_mount.h>
9 #include <linux/sunrpc/addr.h>
10 #include <linux/sunrpc/auth.h>
11 #include <linux/sunrpc/xprt.h>
12 #include <linux/sunrpc/bc_xprt.h>
13 #include <linux/sunrpc/rpc_pipe_fs.h>
14 #include "internal.h"
15 #include "callback.h"
16 #include "delegation.h"
17 #include "nfs4session.h"
18 #include "pnfs.h"
19 #include "netns.h"
20
21 #define NFSDBG_FACILITY         NFSDBG_CLIENT
22
23 /*
24  * Get a unique NFSv4.0 callback identifier which will be used
25  * by the V4.0 callback service to lookup the nfs_client struct
26  */
27 static int nfs_get_cb_ident_idr(struct nfs_client *clp, int minorversion)
28 {
29         int ret = 0;
30         struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
31
32         if (clp->rpc_ops->version != 4 || minorversion != 0)
33                 return ret;
34         idr_preload(GFP_KERNEL);
35         spin_lock(&nn->nfs_client_lock);
36         ret = idr_alloc(&nn->cb_ident_idr, clp, 0, 0, GFP_NOWAIT);
37         if (ret >= 0)
38                 clp->cl_cb_ident = ret;
39         spin_unlock(&nn->nfs_client_lock);
40         idr_preload_end();
41         return ret < 0 ? ret : 0;
42 }
43
44 #ifdef CONFIG_NFS_V4_1
45 /**
46  * Per auth flavor data server rpc clients
47  */
48 struct nfs4_ds_server {
49         struct list_head        list;   /* ds_clp->cl_ds_clients */
50         struct rpc_clnt         *rpc_clnt;
51 };
52
53 /**
54  * Common lookup case for DS I/O
55  */
56 static struct nfs4_ds_server *
57 nfs4_find_ds_client(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
58 {
59         struct nfs4_ds_server *dss;
60
61         rcu_read_lock();
62         list_for_each_entry_rcu(dss, &ds_clp->cl_ds_clients, list) {
63                 if (dss->rpc_clnt->cl_auth->au_flavor != flavor)
64                         continue;
65                 goto out;
66         }
67         dss = NULL;
68 out:
69         rcu_read_unlock();
70         return dss;
71 }
72
73 static struct nfs4_ds_server *
74 nfs4_add_ds_client(struct nfs_client *ds_clp, rpc_authflavor_t flavor,
75                            struct nfs4_ds_server *new)
76 {
77         struct nfs4_ds_server *dss;
78
79         spin_lock(&ds_clp->cl_lock);
80         list_for_each_entry(dss, &ds_clp->cl_ds_clients, list) {
81                 if (dss->rpc_clnt->cl_auth->au_flavor != flavor)
82                         continue;
83                 goto out;
84         }
85         if (new)
86                 list_add_rcu(&new->list, &ds_clp->cl_ds_clients);
87         dss = new;
88 out:
89         spin_unlock(&ds_clp->cl_lock); /* need some lock to protect list */
90         return dss;
91 }
92
93 static struct nfs4_ds_server *
94 nfs4_alloc_ds_server(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
95 {
96         struct nfs4_ds_server *dss;
97
98         dss = kmalloc(sizeof(*dss), GFP_NOFS);
99         if (dss == NULL)
100                 return ERR_PTR(-ENOMEM);
101
102         dss->rpc_clnt = rpc_clone_client_set_auth(ds_clp->cl_rpcclient, flavor);
103         if (IS_ERR(dss->rpc_clnt)) {
104                 int err = PTR_ERR(dss->rpc_clnt);
105                 kfree (dss);
106                 return ERR_PTR(err);
107         }
108         INIT_LIST_HEAD(&dss->list);
109
110         return dss;
111 }
112
113 static void
114 nfs4_free_ds_server(struct nfs4_ds_server *dss)
115 {
116         rpc_release_client(dss->rpc_clnt);
117         kfree(dss);
118 }
119
120 /**
121 * Find or create a DS rpc client with th MDS server rpc client auth flavor
122 * in the nfs_client cl_ds_clients list.
123 */
124 struct rpc_clnt *
125 nfs4_find_or_create_ds_client(struct nfs_client *ds_clp, struct inode *inode)
126 {
127         struct nfs4_ds_server *dss, *new;
128         rpc_authflavor_t flavor = NFS_SERVER(inode)->client->cl_auth->au_flavor;
129
130         dss = nfs4_find_ds_client(ds_clp, flavor);
131         if (dss != NULL)
132                 goto out;
133         new = nfs4_alloc_ds_server(ds_clp, flavor);
134         if (IS_ERR(new))
135                 return ERR_CAST(new);
136         dss = nfs4_add_ds_client(ds_clp, flavor, new);
137         if (dss != new)
138                 nfs4_free_ds_server(new);
139 out:
140         return dss->rpc_clnt;
141 }
142 EXPORT_SYMBOL_GPL(nfs4_find_or_create_ds_client);
143
144 static void
145 nfs4_shutdown_ds_clients(struct nfs_client *clp)
146 {
147         struct nfs4_ds_server *dss;
148         LIST_HEAD(shutdown_list);
149
150         while (!list_empty(&clp->cl_ds_clients)) {
151                 dss = list_entry(clp->cl_ds_clients.next,
152                                         struct nfs4_ds_server, list);
153                 list_del(&dss->list);
154                 rpc_shutdown_client(dss->rpc_clnt);
155                 kfree (dss);
156         }
157 }
158
159 void nfs41_shutdown_client(struct nfs_client *clp)
160 {
161         if (nfs4_has_session(clp)) {
162                 nfs4_shutdown_ds_clients(clp);
163                 nfs4_destroy_session(clp->cl_session);
164                 nfs4_destroy_clientid(clp);
165         }
166
167 }
168 #endif  /* CONFIG_NFS_V4_1 */
169
170 void nfs40_shutdown_client(struct nfs_client *clp)
171 {
172         if (clp->cl_slot_tbl) {
173                 nfs4_release_slot_table(clp->cl_slot_tbl);
174                 kfree(clp->cl_slot_tbl);
175         }
176 }
177
178 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *cl_init)
179 {
180         int err;
181         struct nfs_client *clp = nfs_alloc_client(cl_init);
182         if (IS_ERR(clp))
183                 return clp;
184
185         err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
186         if (err)
187                 goto error;
188
189         if (cl_init->minorversion > NFS4_MAX_MINOR_VERSION) {
190                 err = -EINVAL;
191                 goto error;
192         }
193
194         spin_lock_init(&clp->cl_lock);
195         INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
196         INIT_LIST_HEAD(&clp->cl_ds_clients);
197         rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
198         clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
199         clp->cl_minorversion = cl_init->minorversion;
200         clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
201         clp->cl_mig_gen = 1;
202         return clp;
203
204 error:
205         nfs_free_client(clp);
206         return ERR_PTR(err);
207 }
208
209 /*
210  * Destroy the NFS4 callback service
211  */
212 static void nfs4_destroy_callback(struct nfs_client *clp)
213 {
214         if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
215                 nfs_callback_down(clp->cl_mvops->minor_version, clp->cl_net);
216 }
217
218 static void nfs4_shutdown_client(struct nfs_client *clp)
219 {
220         if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
221                 nfs4_kill_renewd(clp);
222         clp->cl_mvops->shutdown_client(clp);
223         nfs4_destroy_callback(clp);
224         if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
225                 nfs_idmap_delete(clp);
226
227         rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
228         kfree(clp->cl_serverowner);
229         kfree(clp->cl_serverscope);
230         kfree(clp->cl_implid);
231 }
232
233 void nfs4_free_client(struct nfs_client *clp)
234 {
235         nfs4_shutdown_client(clp);
236         nfs_free_client(clp);
237 }
238
239 /*
240  * Initialize the NFS4 callback service
241  */
242 static int nfs4_init_callback(struct nfs_client *clp)
243 {
244         int error;
245
246         if (clp->rpc_ops->version == 4) {
247                 struct rpc_xprt *xprt;
248
249                 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
250
251                 if (nfs4_has_session(clp)) {
252                         error = xprt_setup_backchannel(xprt,
253                                                 NFS41_BC_MIN_CALLBACKS);
254                         if (error < 0)
255                                 return error;
256                 }
257
258                 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
259                 if (error < 0) {
260                         dprintk("%s: failed to start callback. Error = %d\n",
261                                 __func__, error);
262                         return error;
263                 }
264                 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
265         }
266         return 0;
267 }
268
269 /**
270  * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
271  * @clp - nfs_client to initialize
272  *
273  * Returns zero on success, or a negative errno if some error occurred.
274  */
275 int nfs40_init_client(struct nfs_client *clp)
276 {
277         struct nfs4_slot_table *tbl;
278         int ret;
279
280         tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
281         if (tbl == NULL)
282                 return -ENOMEM;
283
284         ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
285                                         "NFSv4.0 transport Slot table");
286         if (ret) {
287                 kfree(tbl);
288                 return ret;
289         }
290
291         clp->cl_slot_tbl = tbl;
292         return 0;
293 }
294
295 #if defined(CONFIG_NFS_V4_1)
296
297 /**
298  * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
299  * @clp - nfs_client to initialize
300  *
301  * Returns zero on success, or a negative errno if some error occurred.
302  */
303 int nfs41_init_client(struct nfs_client *clp)
304 {
305         struct nfs4_session *session = NULL;
306
307         /*
308          * Create the session and mark it expired.
309          * When a SEQUENCE operation encounters the expired session
310          * it will do session recovery to initialize it.
311          */
312         session = nfs4_alloc_session(clp);
313         if (!session)
314                 return -ENOMEM;
315
316         clp->cl_session = session;
317
318         /*
319          * The create session reply races with the server back
320          * channel probe. Mark the client NFS_CS_SESSION_INITING
321          * so that the client back channel can find the
322          * nfs_client struct
323          */
324         nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
325         return 0;
326 }
327
328 #endif  /* CONFIG_NFS_V4_1 */
329
330 /*
331  * Initialize the minor version specific parts of an NFS4 client record
332  */
333 static int nfs4_init_client_minor_version(struct nfs_client *clp)
334 {
335         int ret;
336
337         ret = clp->cl_mvops->init_client(clp);
338         if (ret)
339                 return ret;
340         return nfs4_init_callback(clp);
341 }
342
343 /**
344  * nfs4_init_client - Initialise an NFS4 client record
345  *
346  * @clp: nfs_client to initialise
347  * @timeparms: timeout parameters for underlying RPC transport
348  * @ip_addr: callback IP address in presentation format
349  * @authflavor: authentication flavor for underlying RPC transport
350  *
351  * Returns pointer to an NFS client, or an ERR_PTR value.
352  */
353 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
354                                     const struct rpc_timeout *timeparms,
355                                     const char *ip_addr)
356 {
357         char buf[INET6_ADDRSTRLEN + 1];
358         struct nfs_client *old;
359         int error;
360
361         if (clp->cl_cons_state == NFS_CS_READY) {
362                 /* the client is initialised already */
363                 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
364                 return clp;
365         }
366
367         /* Check NFS protocol revision and initialize RPC op vector */
368         clp->rpc_ops = &nfs_v4_clientops;
369
370         if (clp->cl_minorversion != 0)
371                 __set_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags);
372         __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
373         __set_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags);
374
375         error = -EINVAL;
376         if (gssd_running(clp->cl_net))
377                 error = nfs_create_rpc_client(clp, timeparms,
378                                               RPC_AUTH_GSS_KRB5I);
379         if (error == -EINVAL)
380                 error = nfs_create_rpc_client(clp, timeparms, RPC_AUTH_UNIX);
381         if (error < 0)
382                 goto error;
383
384         /* If no clientaddr= option was specified, find a usable cb address */
385         if (ip_addr == NULL) {
386                 struct sockaddr_storage cb_addr;
387                 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
388
389                 error = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
390                 if (error < 0)
391                         goto error;
392                 error = rpc_ntop(sap, buf, sizeof(buf));
393                 if (error < 0)
394                         goto error;
395                 ip_addr = (const char *)buf;
396         }
397         strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
398
399         error = nfs_idmap_new(clp);
400         if (error < 0) {
401                 dprintk("%s: failed to create idmapper. Error = %d\n",
402                         __func__, error);
403                 goto error;
404         }
405         __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
406
407         error = nfs4_init_client_minor_version(clp);
408         if (error < 0)
409                 goto error;
410
411         if (!nfs4_has_session(clp))
412                 nfs_mark_client_ready(clp, NFS_CS_READY);
413
414         error = nfs4_discover_server_trunking(clp, &old);
415         if (error < 0)
416                 goto error;
417
418         if (clp != old)
419                 clp->cl_preserve_clid = true;
420         nfs_put_client(clp);
421         return old;
422
423 error:
424         nfs_mark_client_ready(clp, error);
425         nfs_put_client(clp);
426         dprintk("<-- nfs4_init_client() = xerror %d\n", error);
427         return ERR_PTR(error);
428 }
429
430 /*
431  * SETCLIENTID just did a callback update with the callback ident in
432  * "drop," but server trunking discovery claims "drop" and "keep" are
433  * actually the same server.  Swap the callback IDs so that "keep"
434  * will continue to use the callback ident the server now knows about,
435  * and so that "keep"'s original callback ident is destroyed when
436  * "drop" is freed.
437  */
438 static void nfs4_swap_callback_idents(struct nfs_client *keep,
439                                       struct nfs_client *drop)
440 {
441         struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
442         unsigned int save = keep->cl_cb_ident;
443
444         if (keep->cl_cb_ident == drop->cl_cb_ident)
445                 return;
446
447         dprintk("%s: keeping callback ident %u and dropping ident %u\n",
448                 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
449
450         spin_lock(&nn->nfs_client_lock);
451
452         idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
453         keep->cl_cb_ident = drop->cl_cb_ident;
454
455         idr_replace(&nn->cb_ident_idr, drop, save);
456         drop->cl_cb_ident = save;
457
458         spin_unlock(&nn->nfs_client_lock);
459 }
460
461 /**
462  * nfs40_walk_client_list - Find server that recognizes a client ID
463  *
464  * @new: nfs_client with client ID to test
465  * @result: OUT: found nfs_client, or new
466  * @cred: credential to use for trunking test
467  *
468  * Returns zero, a negative errno, or a negative NFS4ERR status.
469  * If zero is returned, an nfs_client pointer is planted in "result."
470  *
471  * NB: nfs40_walk_client_list() relies on the new nfs_client being
472  *     the last nfs_client on the list.
473  */
474 int nfs40_walk_client_list(struct nfs_client *new,
475                            struct nfs_client **result,
476                            struct rpc_cred *cred)
477 {
478         struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
479         struct nfs_client *pos, *prev = NULL;
480         struct nfs4_setclientid_res clid = {
481                 .clientid       = new->cl_clientid,
482                 .confirm        = new->cl_confirm,
483         };
484         int status = -NFS4ERR_STALE_CLIENTID;
485
486         spin_lock(&nn->nfs_client_lock);
487         list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
488                 /* If "pos" isn't marked ready, we can't trust the
489                  * remaining fields in "pos" */
490                 if (pos->cl_cons_state > NFS_CS_READY) {
491                         atomic_inc(&pos->cl_count);
492                         spin_unlock(&nn->nfs_client_lock);
493
494                         if (prev)
495                                 nfs_put_client(prev);
496                         prev = pos;
497
498                         status = nfs_wait_client_init_complete(pos);
499                         if (status < 0)
500                                 goto out;
501                         status = -NFS4ERR_STALE_CLIENTID;
502                         spin_lock(&nn->nfs_client_lock);
503                 }
504                 if (pos->cl_cons_state != NFS_CS_READY)
505                         continue;
506
507                 if (pos->rpc_ops != new->rpc_ops)
508                         continue;
509
510                 if (pos->cl_proto != new->cl_proto)
511                         continue;
512
513                 if (pos->cl_minorversion != new->cl_minorversion)
514                         continue;
515
516                 if (pos->cl_clientid != new->cl_clientid)
517                         continue;
518
519                 atomic_inc(&pos->cl_count);
520                 spin_unlock(&nn->nfs_client_lock);
521
522                 if (prev)
523                         nfs_put_client(prev);
524                 prev = pos;
525
526                 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
527                 switch (status) {
528                 case -NFS4ERR_STALE_CLIENTID:
529                         break;
530                 case 0:
531                         nfs4_swap_callback_idents(pos, new);
532
533                         prev = NULL;
534                         *result = pos;
535                         dprintk("NFS: <-- %s using nfs_client = %p ({%d})\n",
536                                 __func__, pos, atomic_read(&pos->cl_count));
537                 default:
538                         goto out;
539                 }
540
541                 spin_lock(&nn->nfs_client_lock);
542         }
543         spin_unlock(&nn->nfs_client_lock);
544
545         /* No match found. The server lost our clientid */
546 out:
547         if (prev)
548                 nfs_put_client(prev);
549         dprintk("NFS: <-- %s status = %d\n", __func__, status);
550         return status;
551 }
552
553 #ifdef CONFIG_NFS_V4_1
554 /*
555  * Returns true if the client IDs match
556  */
557 static bool nfs4_match_clientids(struct nfs_client *a, struct nfs_client *b)
558 {
559         if (a->cl_clientid != b->cl_clientid) {
560                 dprintk("NFS: --> %s client ID %llx does not match %llx\n",
561                         __func__, a->cl_clientid, b->cl_clientid);
562                 return false;
563         }
564         dprintk("NFS: --> %s client ID %llx matches %llx\n",
565                 __func__, a->cl_clientid, b->cl_clientid);
566         return true;
567 }
568
569 /*
570  * Returns true if the server owners match
571  */
572 static bool
573 nfs4_match_serverowners(struct nfs_client *a, struct nfs_client *b)
574 {
575         struct nfs41_server_owner *o1 = a->cl_serverowner;
576         struct nfs41_server_owner *o2 = b->cl_serverowner;
577
578         if (o1->minor_id != o2->minor_id) {
579                 dprintk("NFS: --> %s server owner minor IDs do not match\n",
580                         __func__);
581                 return false;
582         }
583
584         if (o1->major_id_sz != o2->major_id_sz)
585                 goto out_major_mismatch;
586         if (memcmp(o1->major_id, o2->major_id, o1->major_id_sz) != 0)
587                 goto out_major_mismatch;
588
589         dprintk("NFS: --> %s server owners match\n", __func__);
590         return true;
591
592 out_major_mismatch:
593         dprintk("NFS: --> %s server owner major IDs do not match\n",
594                 __func__);
595         return false;
596 }
597
598 /**
599  * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
600  *
601  * @new: nfs_client with client ID to test
602  * @result: OUT: found nfs_client, or new
603  * @cred: credential to use for trunking test
604  *
605  * Returns zero, a negative errno, or a negative NFS4ERR status.
606  * If zero is returned, an nfs_client pointer is planted in "result."
607  *
608  * NB: nfs41_walk_client_list() relies on the new nfs_client being
609  *     the last nfs_client on the list.
610  */
611 int nfs41_walk_client_list(struct nfs_client *new,
612                            struct nfs_client **result,
613                            struct rpc_cred *cred)
614 {
615         struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
616         struct nfs_client *pos, *prev = NULL;
617         int status = -NFS4ERR_STALE_CLIENTID;
618
619         spin_lock(&nn->nfs_client_lock);
620         list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
621                 /* If "pos" isn't marked ready, we can't trust the
622                  * remaining fields in "pos", especially the client
623                  * ID and serverowner fields.  Wait for CREATE_SESSION
624                  * to finish. */
625                 if (pos->cl_cons_state > NFS_CS_READY) {
626                         atomic_inc(&pos->cl_count);
627                         spin_unlock(&nn->nfs_client_lock);
628
629                         if (prev)
630                                 nfs_put_client(prev);
631                         prev = pos;
632
633                         status = nfs_wait_client_init_complete(pos);
634                         if (status == 0) {
635                                 nfs4_schedule_lease_recovery(pos);
636                                 status = nfs4_wait_clnt_recover(pos);
637                         }
638                         spin_lock(&nn->nfs_client_lock);
639                         if (status < 0)
640                                 break;
641                         status = -NFS4ERR_STALE_CLIENTID;
642                 }
643                 if (pos->cl_cons_state != NFS_CS_READY)
644                         continue;
645
646                 if (pos->rpc_ops != new->rpc_ops)
647                         continue;
648
649                 if (pos->cl_proto != new->cl_proto)
650                         continue;
651
652                 if (pos->cl_minorversion != new->cl_minorversion)
653                         continue;
654
655                 if (!nfs4_match_clientids(pos, new))
656                         continue;
657
658                 if (!nfs4_match_serverowners(pos, new))
659                         continue;
660
661                 atomic_inc(&pos->cl_count);
662                 *result = pos;
663                 status = 0;
664                 dprintk("NFS: <-- %s using nfs_client = %p ({%d})\n",
665                         __func__, pos, atomic_read(&pos->cl_count));
666                 break;
667         }
668
669         /* No matching nfs_client found. */
670         spin_unlock(&nn->nfs_client_lock);
671         dprintk("NFS: <-- %s status = %d\n", __func__, status);
672         if (prev)
673                 nfs_put_client(prev);
674         return status;
675 }
676 #endif  /* CONFIG_NFS_V4_1 */
677
678 static void nfs4_destroy_server(struct nfs_server *server)
679 {
680         nfs_server_return_all_delegations(server);
681         unset_pnfs_layoutdriver(server);
682         nfs4_purge_state_owners(server);
683 }
684
685 /*
686  * NFSv4.0 callback thread helper
687  *
688  * Find a client by callback identifier
689  */
690 struct nfs_client *
691 nfs4_find_client_ident(struct net *net, int cb_ident)
692 {
693         struct nfs_client *clp;
694         struct nfs_net *nn = net_generic(net, nfs_net_id);
695
696         spin_lock(&nn->nfs_client_lock);
697         clp = idr_find(&nn->cb_ident_idr, cb_ident);
698         if (clp)
699                 atomic_inc(&clp->cl_count);
700         spin_unlock(&nn->nfs_client_lock);
701         return clp;
702 }
703
704 #if defined(CONFIG_NFS_V4_1)
705 /* Common match routine for v4.0 and v4.1 callback services */
706 static bool nfs4_cb_match_client(const struct sockaddr *addr,
707                 struct nfs_client *clp, u32 minorversion)
708 {
709         struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
710
711         /* Don't match clients that failed to initialise */
712         if (!(clp->cl_cons_state == NFS_CS_READY ||
713             clp->cl_cons_state == NFS_CS_SESSION_INITING))
714                 return false;
715
716         smp_rmb();
717
718         /* Match the version and minorversion */
719         if (clp->rpc_ops->version != 4 ||
720             clp->cl_minorversion != minorversion)
721                 return false;
722
723         /* Match only the IP address, not the port number */
724         if (!nfs_sockaddr_match_ipaddr(addr, clap))
725                 return false;
726
727         return true;
728 }
729
730 /*
731  * NFSv4.1 callback thread helper
732  * For CB_COMPOUND calls, find a client by IP address, protocol version,
733  * minorversion, and sessionID
734  *
735  * Returns NULL if no such client
736  */
737 struct nfs_client *
738 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
739                            struct nfs4_sessionid *sid, u32 minorversion)
740 {
741         struct nfs_client *clp;
742         struct nfs_net *nn = net_generic(net, nfs_net_id);
743
744         spin_lock(&nn->nfs_client_lock);
745         list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
746                 if (nfs4_cb_match_client(addr, clp, minorversion) == false)
747                         continue;
748
749                 if (!nfs4_has_session(clp))
750                         continue;
751
752                 /* Match sessionid*/
753                 if (memcmp(clp->cl_session->sess_id.data,
754                     sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
755                         continue;
756
757                 atomic_inc(&clp->cl_count);
758                 spin_unlock(&nn->nfs_client_lock);
759                 return clp;
760         }
761         spin_unlock(&nn->nfs_client_lock);
762         return NULL;
763 }
764
765 #else /* CONFIG_NFS_V4_1 */
766
767 struct nfs_client *
768 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
769                            struct nfs4_sessionid *sid, u32 minorversion)
770 {
771         return NULL;
772 }
773 #endif /* CONFIG_NFS_V4_1 */
774
775 /*
776  * Set up an NFS4 client
777  */
778 static int nfs4_set_client(struct nfs_server *server,
779                 const char *hostname,
780                 const struct sockaddr *addr,
781                 const size_t addrlen,
782                 const char *ip_addr,
783                 rpc_authflavor_t authflavour,
784                 int proto, const struct rpc_timeout *timeparms,
785                 u32 minorversion, struct net *net)
786 {
787         struct nfs_client_initdata cl_init = {
788                 .hostname = hostname,
789                 .addr = addr,
790                 .addrlen = addrlen,
791                 .nfs_mod = &nfs_v4,
792                 .proto = proto,
793                 .minorversion = minorversion,
794                 .net = net,
795         };
796         struct nfs_client *clp;
797         int error;
798
799         dprintk("--> nfs4_set_client()\n");
800
801         if (server->flags & NFS_MOUNT_NORESVPORT)
802                 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
803         if (server->options & NFS_OPTION_MIGRATION)
804                 set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
805
806         /* Allocate or find a client reference we can use */
807         clp = nfs_get_client(&cl_init, timeparms, ip_addr, authflavour);
808         if (IS_ERR(clp)) {
809                 error = PTR_ERR(clp);
810                 goto error;
811         }
812
813         /*
814          * Query for the lease time on clientid setup or renewal
815          *
816          * Note that this will be set on nfs_clients that were created
817          * only for the DS role and did not set this bit, but now will
818          * serve a dual role.
819          */
820         set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
821
822         server->nfs_client = clp;
823         dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
824         return 0;
825 error:
826         dprintk("<-- nfs4_set_client() = xerror %d\n", error);
827         return error;
828 }
829
830 /*
831  * Set up a pNFS Data Server client.
832  *
833  * Return any existing nfs_client that matches server address,port,version
834  * and minorversion.
835  *
836  * For a new nfs_client, use a soft mount (default), a low retrans and a
837  * low timeout interval so that if a connection is lost, we retry through
838  * the MDS.
839  */
840 struct nfs_client *nfs4_set_ds_client(struct nfs_client* mds_clp,
841                 const struct sockaddr *ds_addr, int ds_addrlen,
842                 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans)
843 {
844         struct nfs_client_initdata cl_init = {
845                 .addr = ds_addr,
846                 .addrlen = ds_addrlen,
847                 .nfs_mod = &nfs_v4,
848                 .proto = ds_proto,
849                 .minorversion = mds_clp->cl_minorversion,
850                 .net = mds_clp->cl_net,
851         };
852         struct rpc_timeout ds_timeout;
853         struct nfs_client *clp;
854
855         /*
856          * Set an authflavor equual to the MDS value. Use the MDS nfs_client
857          * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
858          * (section 13.1 RFC 5661).
859          */
860         nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
861         clp = nfs_get_client(&cl_init, &ds_timeout, mds_clp->cl_ipaddr,
862                              mds_clp->cl_rpcclient->cl_auth->au_flavor);
863
864         dprintk("<-- %s %p\n", __func__, clp);
865         return clp;
866 }
867 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
868
869 /*
870  * Session has been established, and the client marked ready.
871  * Set the mount rsize and wsize with negotiated fore channel
872  * attributes which will be bound checked in nfs_server_set_fsinfo.
873  */
874 static void nfs4_session_set_rwsize(struct nfs_server *server)
875 {
876 #ifdef CONFIG_NFS_V4_1
877         struct nfs4_session *sess;
878         u32 server_resp_sz;
879         u32 server_rqst_sz;
880
881         if (!nfs4_has_session(server->nfs_client))
882                 return;
883         sess = server->nfs_client->cl_session;
884         server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
885         server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
886
887         if (server->rsize > server_resp_sz)
888                 server->rsize = server_resp_sz;
889         if (server->wsize > server_rqst_sz)
890                 server->wsize = server_rqst_sz;
891 #endif /* CONFIG_NFS_V4_1 */
892 }
893
894 static int nfs4_server_common_setup(struct nfs_server *server,
895                 struct nfs_fh *mntfh, bool auth_probe)
896 {
897         struct nfs_fattr *fattr;
898         int error;
899
900         /* data servers support only a subset of NFSv4.1 */
901         if (is_ds_only_client(server->nfs_client))
902                 return -EPROTONOSUPPORT;
903
904         fattr = nfs_alloc_fattr();
905         if (fattr == NULL)
906                 return -ENOMEM;
907
908         /* We must ensure the session is initialised first */
909         error = nfs4_init_session(server->nfs_client);
910         if (error < 0)
911                 goto out;
912
913         /* Set the basic capabilities */
914         server->caps |= server->nfs_client->cl_mvops->init_caps;
915         if (server->flags & NFS_MOUNT_NORDIRPLUS)
916                         server->caps &= ~NFS_CAP_READDIRPLUS;
917         /*
918          * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
919          * authentication.
920          */
921         if (nfs4_disable_idmapping &&
922                         server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
923                 server->caps |= NFS_CAP_UIDGID_NOMAP;
924
925
926         /* Probe the root fh to retrieve its FSID and filehandle */
927         error = nfs4_get_rootfh(server, mntfh, auth_probe);
928         if (error < 0)
929                 goto out;
930
931         dprintk("Server FSID: %llx:%llx\n",
932                         (unsigned long long) server->fsid.major,
933                         (unsigned long long) server->fsid.minor);
934         nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
935
936         nfs4_session_set_rwsize(server);
937
938         error = nfs_probe_fsinfo(server, mntfh, fattr);
939         if (error < 0)
940                 goto out;
941
942         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
943                 server->namelen = NFS4_MAXNAMLEN;
944
945         nfs_server_insert_lists(server);
946         server->mount_time = jiffies;
947         server->destroy = nfs4_destroy_server;
948 out:
949         nfs_free_fattr(fattr);
950         return error;
951 }
952
953 /*
954  * Create a version 4 volume record
955  */
956 static int nfs4_init_server(struct nfs_server *server,
957                 struct nfs_parsed_mount_data *data)
958 {
959         struct rpc_timeout timeparms;
960         int error;
961
962         dprintk("--> nfs4_init_server()\n");
963
964         nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
965                         data->timeo, data->retrans);
966
967         /* Initialise the client representation from the mount data */
968         server->flags = data->flags;
969         server->options = data->options;
970         server->auth_info = data->auth_info;
971
972         /* Use the first specified auth flavor. If this flavor isn't
973          * allowed by the server, use the SECINFO path to try the
974          * other specified flavors */
975         if (data->auth_info.flavor_len >= 1)
976                 data->selected_flavor = data->auth_info.flavors[0];
977         else
978                 data->selected_flavor = RPC_AUTH_UNIX;
979
980         /* Get a client record */
981         error = nfs4_set_client(server,
982                         data->nfs_server.hostname,
983                         (const struct sockaddr *)&data->nfs_server.address,
984                         data->nfs_server.addrlen,
985                         data->client_address,
986                         data->selected_flavor,
987                         data->nfs_server.protocol,
988                         &timeparms,
989                         data->minorversion,
990                         data->net);
991         if (error < 0)
992                 goto error;
993
994         if (data->rsize)
995                 server->rsize = nfs_block_size(data->rsize, NULL);
996         if (data->wsize)
997                 server->wsize = nfs_block_size(data->wsize, NULL);
998
999         server->acregmin = data->acregmin * HZ;
1000         server->acregmax = data->acregmax * HZ;
1001         server->acdirmin = data->acdirmin * HZ;
1002         server->acdirmax = data->acdirmax * HZ;
1003
1004         server->port = data->nfs_server.port;
1005
1006         error = nfs_init_server_rpcclient(server, &timeparms,
1007                                           data->selected_flavor);
1008
1009 error:
1010         /* Done */
1011         dprintk("<-- nfs4_init_server() = %d\n", error);
1012         return error;
1013 }
1014
1015 /*
1016  * Create a version 4 volume record
1017  * - keyed on server and FSID
1018  */
1019 /*struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1020                                       struct nfs_fh *mntfh)*/
1021 struct nfs_server *nfs4_create_server(struct nfs_mount_info *mount_info,
1022                                       struct nfs_subversion *nfs_mod)
1023 {
1024         struct nfs_server *server;
1025         bool auth_probe;
1026         int error;
1027
1028         dprintk("--> nfs4_create_server()\n");
1029
1030         server = nfs_alloc_server();
1031         if (!server)
1032                 return ERR_PTR(-ENOMEM);
1033
1034         auth_probe = mount_info->parsed->auth_info.flavor_len < 1;
1035
1036         /* set up the general RPC client */
1037         error = nfs4_init_server(server, mount_info->parsed);
1038         if (error < 0)
1039                 goto error;
1040
1041         error = nfs4_server_common_setup(server, mount_info->mntfh, auth_probe);
1042         if (error < 0)
1043                 goto error;
1044
1045         dprintk("<-- nfs4_create_server() = %p\n", server);
1046         return server;
1047
1048 error:
1049         nfs_free_server(server);
1050         dprintk("<-- nfs4_create_server() = error %d\n", error);
1051         return ERR_PTR(error);
1052 }
1053
1054 /*
1055  * Create an NFS4 referral server record
1056  */
1057 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1058                                                struct nfs_fh *mntfh)
1059 {
1060         struct nfs_client *parent_client;
1061         struct nfs_server *server, *parent_server;
1062         bool auth_probe;
1063         int error;
1064
1065         dprintk("--> nfs4_create_referral_server()\n");
1066
1067         server = nfs_alloc_server();
1068         if (!server)
1069                 return ERR_PTR(-ENOMEM);
1070
1071         parent_server = NFS_SB(data->sb);
1072         parent_client = parent_server->nfs_client;
1073
1074         /* Initialise the client representation from the parent server */
1075         nfs_server_copy_userdata(server, parent_server);
1076
1077         /* Get a client representation.
1078          * Note: NFSv4 always uses TCP, */
1079         error = nfs4_set_client(server, data->hostname,
1080                                 data->addr,
1081                                 data->addrlen,
1082                                 parent_client->cl_ipaddr,
1083                                 data->authflavor,
1084                                 rpc_protocol(parent_server->client),
1085                                 parent_server->client->cl_timeout,
1086                                 parent_client->cl_mvops->minor_version,
1087                                 parent_client->cl_net);
1088         if (error < 0)
1089                 goto error;
1090
1091         error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1092         if (error < 0)
1093                 goto error;
1094
1095         auth_probe = parent_server->auth_info.flavor_len < 1;
1096
1097         error = nfs4_server_common_setup(server, mntfh, auth_probe);
1098         if (error < 0)
1099                 goto error;
1100
1101         dprintk("<-- nfs_create_referral_server() = %p\n", server);
1102         return server;
1103
1104 error:
1105         nfs_free_server(server);
1106         dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1107         return ERR_PTR(error);
1108 }
1109
1110 /*
1111  * Grab the destination's particulars, including lease expiry time.
1112  *
1113  * Returns zero if probe succeeded and retrieved FSID matches the FSID
1114  * we have cached.
1115  */
1116 static int nfs_probe_destination(struct nfs_server *server)
1117 {
1118         struct inode *inode = server->super->s_root->d_inode;
1119         struct nfs_fattr *fattr;
1120         int error;
1121
1122         fattr = nfs_alloc_fattr();
1123         if (fattr == NULL)
1124                 return -ENOMEM;
1125
1126         /* Sanity: the probe won't work if the destination server
1127          * does not recognize the migrated FH. */
1128         error = nfs_probe_fsinfo(server, NFS_FH(inode), fattr);
1129
1130         nfs_free_fattr(fattr);
1131         return error;
1132 }
1133
1134 /**
1135  * nfs4_update_server - Move an nfs_server to a different nfs_client
1136  *
1137  * @server: represents FSID to be moved
1138  * @hostname: new end-point's hostname
1139  * @sap: new end-point's socket address
1140  * @salen: size of "sap"
1141  *
1142  * The nfs_server must be quiescent before this function is invoked.
1143  * Either its session is drained (NFSv4.1+), or its transport is
1144  * plugged and drained (NFSv4.0).
1145  *
1146  * Returns zero on success, or a negative errno value.
1147  */
1148 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1149                        struct sockaddr *sap, size_t salen)
1150 {
1151         struct nfs_client *clp = server->nfs_client;
1152         struct rpc_clnt *clnt = server->client;
1153         struct xprt_create xargs = {
1154                 .ident          = clp->cl_proto,
1155                 .net            = &init_net,
1156                 .dstaddr        = sap,
1157                 .addrlen        = salen,
1158                 .servername     = hostname,
1159         };
1160         char buf[INET6_ADDRSTRLEN + 1];
1161         struct sockaddr_storage address;
1162         struct sockaddr *localaddr = (struct sockaddr *)&address;
1163         int error;
1164
1165         dprintk("--> %s: move FSID %llx:%llx to \"%s\")\n", __func__,
1166                         (unsigned long long)server->fsid.major,
1167                         (unsigned long long)server->fsid.minor,
1168                         hostname);
1169
1170         error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1171         if (error != 0) {
1172                 dprintk("<-- %s(): rpc_switch_client_transport returned %d\n",
1173                         __func__, error);
1174                 goto out;
1175         }
1176
1177         error = rpc_localaddr(clnt, localaddr, sizeof(address));
1178         if (error != 0) {
1179                 dprintk("<-- %s(): rpc_localaddr returned %d\n",
1180                         __func__, error);
1181                 goto out;
1182         }
1183
1184         error = -EAFNOSUPPORT;
1185         if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0) {
1186                 dprintk("<-- %s(): rpc_ntop returned %d\n",
1187                         __func__, error);
1188                 goto out;
1189         }
1190
1191         nfs_server_remove_lists(server);
1192         error = nfs4_set_client(server, hostname, sap, salen, buf,
1193                                 clp->cl_rpcclient->cl_auth->au_flavor,
1194                                 clp->cl_proto, clnt->cl_timeout,
1195                                 clp->cl_minorversion, clp->cl_net);
1196         nfs_put_client(clp);
1197         if (error != 0) {
1198                 nfs_server_insert_lists(server);
1199                 dprintk("<-- %s(): nfs4_set_client returned %d\n",
1200                         __func__, error);
1201                 goto out;
1202         }
1203
1204         if (server->nfs_client->cl_hostname == NULL)
1205                 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1206         nfs_server_insert_lists(server);
1207
1208         error = nfs_probe_destination(server);
1209         if (error < 0)
1210                 goto out;
1211
1212         dprintk("<-- %s() succeeded\n", __func__);
1213
1214 out:
1215         return error;
1216 }