GNU Linux-libre 4.9.337-gnu1
[releases.git] / 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_mount.h>
8 #include <linux/sunrpc/addr.h>
9 #include <linux/sunrpc/auth.h>
10 #include <linux/sunrpc/xprt.h>
11 #include <linux/sunrpc/bc_xprt.h>
12 #include <linux/sunrpc/rpc_pipe_fs.h>
13 #include "internal.h"
14 #include "callback.h"
15 #include "delegation.h"
16 #include "nfs4session.h"
17 #include "nfs4idmap.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, 1, 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_shutdown_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         char buf[INET6_ADDRSTRLEN + 1];
181         const char *ip_addr = cl_init->ip_addr;
182         struct nfs_client *clp = nfs_alloc_client(cl_init);
183         int err;
184
185         if (IS_ERR(clp))
186                 return clp;
187
188         err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
189         if (err)
190                 goto error;
191
192         if (cl_init->minorversion > NFS4_MAX_MINOR_VERSION) {
193                 err = -EINVAL;
194                 goto error;
195         }
196
197         spin_lock_init(&clp->cl_lock);
198         INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
199         INIT_LIST_HEAD(&clp->cl_ds_clients);
200         rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
201         clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
202         clp->cl_minorversion = cl_init->minorversion;
203         clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
204         clp->cl_mig_gen = 1;
205 #if IS_ENABLED(CONFIG_NFS_V4_1)
206         init_waitqueue_head(&clp->cl_lock_waitq);
207 #endif
208
209         if (cl_init->minorversion != 0)
210                 __set_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags);
211         __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
212         __set_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags);
213
214         /*
215          * Set up the connection to the server before we add add to the
216          * global list.
217          */
218         err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_GSS_KRB5I);
219         if (err == -EINVAL)
220                 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
221         if (err < 0)
222                 goto error;
223
224         /* If no clientaddr= option was specified, find a usable cb address */
225         if (ip_addr == NULL) {
226                 struct sockaddr_storage cb_addr;
227                 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
228
229                 err = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
230                 if (err < 0)
231                         goto error;
232                 err = rpc_ntop(sap, buf, sizeof(buf));
233                 if (err < 0)
234                         goto error;
235                 ip_addr = (const char *)buf;
236         }
237         strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
238
239         err = nfs_idmap_new(clp);
240         if (err < 0) {
241                 dprintk("%s: failed to create idmapper. Error = %d\n",
242                         __func__, err);
243                 goto error;
244         }
245         __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
246         return clp;
247
248 error:
249         nfs_free_client(clp);
250         return ERR_PTR(err);
251 }
252
253 /*
254  * Destroy the NFS4 callback service
255  */
256 static void nfs4_destroy_callback(struct nfs_client *clp)
257 {
258         if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
259                 nfs_callback_down(clp->cl_mvops->minor_version, clp->cl_net);
260 }
261
262 static void nfs4_shutdown_client(struct nfs_client *clp)
263 {
264         if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
265                 nfs4_kill_renewd(clp);
266         clp->cl_mvops->shutdown_client(clp);
267         nfs4_destroy_callback(clp);
268         if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
269                 nfs_idmap_delete(clp);
270
271         rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
272         kfree(clp->cl_serverowner);
273         kfree(clp->cl_serverscope);
274         kfree(clp->cl_implid);
275         kfree(clp->cl_owner_id);
276 }
277
278 void nfs4_free_client(struct nfs_client *clp)
279 {
280         nfs4_shutdown_client(clp);
281         nfs_free_client(clp);
282 }
283
284 /*
285  * Initialize the NFS4 callback service
286  */
287 static int nfs4_init_callback(struct nfs_client *clp)
288 {
289         struct rpc_xprt *xprt;
290         int error;
291
292         xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
293
294         if (nfs4_has_session(clp)) {
295                 error = xprt_setup_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
296                 if (error < 0)
297                         return error;
298         }
299
300         error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
301         if (error < 0) {
302                 dprintk("%s: failed to start callback. Error = %d\n",
303                         __func__, error);
304                 return error;
305         }
306         __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
307
308         return 0;
309 }
310
311 /**
312  * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
313  * @clp - nfs_client to initialize
314  *
315  * Returns zero on success, or a negative errno if some error occurred.
316  */
317 int nfs40_init_client(struct nfs_client *clp)
318 {
319         struct nfs4_slot_table *tbl;
320         int ret;
321
322         tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
323         if (tbl == NULL)
324                 return -ENOMEM;
325
326         ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
327                                         "NFSv4.0 transport Slot table");
328         if (ret) {
329                 nfs4_shutdown_slot_table(tbl);
330                 kfree(tbl);
331                 return ret;
332         }
333
334         clp->cl_slot_tbl = tbl;
335         return 0;
336 }
337
338 #if defined(CONFIG_NFS_V4_1)
339
340 /**
341  * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
342  * @clp - nfs_client to initialize
343  *
344  * Returns zero on success, or a negative errno if some error occurred.
345  */
346 int nfs41_init_client(struct nfs_client *clp)
347 {
348         struct nfs4_session *session = NULL;
349
350         /*
351          * Create the session and mark it expired.
352          * When a SEQUENCE operation encounters the expired session
353          * it will do session recovery to initialize it.
354          */
355         session = nfs4_alloc_session(clp);
356         if (!session)
357                 return -ENOMEM;
358
359         clp->cl_session = session;
360
361         /*
362          * The create session reply races with the server back
363          * channel probe. Mark the client NFS_CS_SESSION_INITING
364          * so that the client back channel can find the
365          * nfs_client struct
366          */
367         nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
368         return 0;
369 }
370
371 #endif  /* CONFIG_NFS_V4_1 */
372
373 /*
374  * Initialize the minor version specific parts of an NFS4 client record
375  */
376 static int nfs4_init_client_minor_version(struct nfs_client *clp)
377 {
378         int ret;
379
380         ret = clp->cl_mvops->init_client(clp);
381         if (ret)
382                 return ret;
383         return nfs4_init_callback(clp);
384 }
385
386 /**
387  * nfs4_init_client - Initialise an NFS4 client record
388  *
389  * @clp: nfs_client to initialise
390  * @timeparms: timeout parameters for underlying RPC transport
391  * @ip_addr: callback IP address in presentation format
392  * @authflavor: authentication flavor for underlying RPC transport
393  *
394  * Returns pointer to an NFS client, or an ERR_PTR value.
395  */
396 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
397                                     const struct nfs_client_initdata *cl_init)
398 {
399         struct nfs_client *old;
400         int error;
401
402         if (clp->cl_cons_state == NFS_CS_READY) {
403                 /* the client is initialised already */
404                 dprintk("<-- nfs4_init_client() = 0 [already %p]\n", clp);
405                 return clp;
406         }
407
408         error = nfs4_init_client_minor_version(clp);
409         if (error < 0)
410                 goto error;
411
412         if (!nfs4_has_session(clp))
413                 nfs_mark_client_ready(clp, NFS_CS_READY);
414
415         error = nfs4_discover_server_trunking(clp, &old);
416         if (error < 0)
417                 goto error;
418
419         if (clp != old)
420                 clp->cl_preserve_clid = true;
421         nfs_put_client(clp);
422         return old;
423
424 error:
425         nfs_mark_client_ready(clp, error);
426         nfs_put_client(clp);
427         dprintk("<-- nfs4_init_client() = xerror %d\n", error);
428         return ERR_PTR(error);
429 }
430
431 /*
432  * SETCLIENTID just did a callback update with the callback ident in
433  * "drop," but server trunking discovery claims "drop" and "keep" are
434  * actually the same server.  Swap the callback IDs so that "keep"
435  * will continue to use the callback ident the server now knows about,
436  * and so that "keep"'s original callback ident is destroyed when
437  * "drop" is freed.
438  */
439 static void nfs4_swap_callback_idents(struct nfs_client *keep,
440                                       struct nfs_client *drop)
441 {
442         struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
443         unsigned int save = keep->cl_cb_ident;
444
445         if (keep->cl_cb_ident == drop->cl_cb_ident)
446                 return;
447
448         dprintk("%s: keeping callback ident %u and dropping ident %u\n",
449                 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
450
451         spin_lock(&nn->nfs_client_lock);
452
453         idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
454         keep->cl_cb_ident = drop->cl_cb_ident;
455
456         idr_replace(&nn->cb_ident_idr, drop, save);
457         drop->cl_cb_ident = save;
458
459         spin_unlock(&nn->nfs_client_lock);
460 }
461
462 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
463                 const struct nfs_client *clp2)
464 {
465         if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
466                 return true;
467         return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
468 }
469
470 /**
471  * nfs40_walk_client_list - Find server that recognizes a client ID
472  *
473  * @new: nfs_client with client ID to test
474  * @result: OUT: found nfs_client, or new
475  * @cred: credential to use for trunking test
476  *
477  * Returns zero, a negative errno, or a negative NFS4ERR status.
478  * If zero is returned, an nfs_client pointer is planted in "result."
479  *
480  * NB: nfs40_walk_client_list() relies on the new nfs_client being
481  *     the last nfs_client on the list.
482  */
483 int nfs40_walk_client_list(struct nfs_client *new,
484                            struct nfs_client **result,
485                            struct rpc_cred *cred)
486 {
487         struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
488         struct nfs_client *pos, *prev = NULL;
489         struct nfs4_setclientid_res clid = {
490                 .clientid       = new->cl_clientid,
491                 .confirm        = new->cl_confirm,
492         };
493         int status = -NFS4ERR_STALE_CLIENTID;
494
495         spin_lock(&nn->nfs_client_lock);
496         list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
497
498                 if (pos->rpc_ops != new->rpc_ops)
499                         continue;
500
501                 if (pos->cl_minorversion != new->cl_minorversion)
502                         continue;
503
504                 /* If "pos" isn't marked ready, we can't trust the
505                  * remaining fields in "pos" */
506                 if (pos->cl_cons_state > NFS_CS_READY) {
507                         atomic_inc(&pos->cl_count);
508                         spin_unlock(&nn->nfs_client_lock);
509
510                         nfs_put_client(prev);
511                         prev = pos;
512
513                         status = nfs_wait_client_init_complete(pos);
514                         if (status < 0)
515                                 goto out;
516                         status = -NFS4ERR_STALE_CLIENTID;
517                         spin_lock(&nn->nfs_client_lock);
518                 }
519                 if (pos->cl_cons_state != NFS_CS_READY)
520                         continue;
521
522                 if (pos->cl_clientid != new->cl_clientid)
523                         continue;
524
525                 if (!nfs4_match_client_owner_id(pos, new))
526                         continue;
527
528                 atomic_inc(&pos->cl_count);
529                 spin_unlock(&nn->nfs_client_lock);
530
531                 nfs_put_client(prev);
532                 prev = pos;
533
534                 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
535                 switch (status) {
536                 case -NFS4ERR_STALE_CLIENTID:
537                         break;
538                 case 0:
539                         nfs4_swap_callback_idents(pos, new);
540
541                         prev = NULL;
542                         *result = pos;
543                         dprintk("NFS: <-- %s using nfs_client = %p ({%d})\n",
544                                 __func__, pos, atomic_read(&pos->cl_count));
545                         goto out;
546                 case -ERESTARTSYS:
547                 case -ETIMEDOUT:
548                         /* The callback path may have been inadvertently
549                          * changed. Schedule recovery!
550                          */
551                         nfs4_schedule_path_down_recovery(pos);
552                 default:
553                         goto out;
554                 }
555
556                 spin_lock(&nn->nfs_client_lock);
557         }
558         spin_unlock(&nn->nfs_client_lock);
559
560         /* No match found. The server lost our clientid */
561 out:
562         nfs_put_client(prev);
563         dprintk("NFS: <-- %s status = %d\n", __func__, status);
564         return status;
565 }
566
567 #ifdef CONFIG_NFS_V4_1
568 /*
569  * Returns true if the client IDs match
570  */
571 static bool nfs4_match_clientids(u64 a, u64 b)
572 {
573         if (a != b) {
574                 dprintk("NFS: --> %s client ID %llx does not match %llx\n",
575                         __func__, a, b);
576                 return false;
577         }
578         dprintk("NFS: --> %s client ID %llx matches %llx\n",
579                 __func__, a, b);
580         return true;
581 }
582
583 /*
584  * Returns true if the server major ids match
585  */
586 static bool
587 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
588                                 struct nfs41_server_owner *o2)
589 {
590         if (o1->major_id_sz != o2->major_id_sz)
591                 goto out_major_mismatch;
592         if (memcmp(o1->major_id, o2->major_id, o1->major_id_sz) != 0)
593                 goto out_major_mismatch;
594
595         dprintk("NFS: --> %s server owner major IDs match\n", __func__);
596         return true;
597
598 out_major_mismatch:
599         dprintk("NFS: --> %s server owner major IDs do not match\n",
600                 __func__);
601         return false;
602 }
603
604 /*
605  * Returns true if server minor ids match
606  */
607 static bool
608 nfs4_check_serverowner_minor_id(struct nfs41_server_owner *o1,
609                                 struct nfs41_server_owner *o2)
610 {
611         /* Check eir_server_owner so_minor_id */
612         if (o1->minor_id != o2->minor_id)
613                 goto out_minor_mismatch;
614
615         dprintk("NFS: --> %s server owner minor IDs match\n", __func__);
616         return true;
617
618 out_minor_mismatch:
619         dprintk("NFS: --> %s server owner minor IDs do not match\n", __func__);
620         return false;
621 }
622
623 /*
624  * Returns true if the server scopes match
625  */
626 static bool
627 nfs4_check_server_scope(struct nfs41_server_scope *s1,
628                         struct nfs41_server_scope *s2)
629 {
630         if (s1->server_scope_sz != s2->server_scope_sz)
631                 goto out_scope_mismatch;
632         if (memcmp(s1->server_scope, s2->server_scope,
633                    s1->server_scope_sz) != 0)
634                 goto out_scope_mismatch;
635
636         dprintk("NFS: --> %s server scopes match\n", __func__);
637         return true;
638
639 out_scope_mismatch:
640         dprintk("NFS: --> %s server scopes do not match\n",
641                 __func__);
642         return false;
643 }
644
645 /**
646  * nfs4_detect_session_trunking - Checks for session trunking.
647  *
648  * Called after a successful EXCHANGE_ID on a multi-addr connection.
649  * Upon success, add the transport.
650  *
651  * @clp:    original mount nfs_client
652  * @res:    result structure from an exchange_id using the original mount
653  *          nfs_client with a new multi_addr transport
654  *
655  * Returns zero on success, otherwise -EINVAL
656  *
657  * Note: since the exchange_id for the new multi_addr transport uses the
658  * same nfs_client from the original mount, the cl_owner_id is reused,
659  * so eir_clientowner is the same.
660  */
661 int nfs4_detect_session_trunking(struct nfs_client *clp,
662                                  struct nfs41_exchange_id_res *res,
663                                  struct rpc_xprt *xprt)
664 {
665         /* Check eir_clientid */
666         if (!nfs4_match_clientids(clp->cl_clientid, res->clientid))
667                 goto out_err;
668
669         /* Check eir_server_owner so_major_id */
670         if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
671                                              res->server_owner))
672                 goto out_err;
673
674         /* Check eir_server_owner so_minor_id */
675         if (!nfs4_check_serverowner_minor_id(clp->cl_serverowner,
676                                              res->server_owner))
677                 goto out_err;
678
679         /* Check eir_server_scope */
680         if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
681                 goto out_err;
682
683         /* Session trunking passed, add the xprt */
684         rpc_clnt_xprt_switch_add_xprt(clp->cl_rpcclient, xprt);
685
686         pr_info("NFS:  %s: Session trunking succeeded for %s\n",
687                 clp->cl_hostname,
688                 xprt->address_strings[RPC_DISPLAY_ADDR]);
689
690         return 0;
691 out_err:
692         pr_info("NFS:  %s: Session trunking failed for %s\n", clp->cl_hostname,
693                 xprt->address_strings[RPC_DISPLAY_ADDR]);
694
695         return -EINVAL;
696 }
697
698 /**
699  * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
700  *
701  * @new: nfs_client with client ID to test
702  * @result: OUT: found nfs_client, or new
703  * @cred: credential to use for trunking test
704  *
705  * Returns zero, a negative errno, or a negative NFS4ERR status.
706  * If zero is returned, an nfs_client pointer is planted in "result."
707  *
708  * NB: nfs41_walk_client_list() relies on the new nfs_client being
709  *     the last nfs_client on the list.
710  */
711 int nfs41_walk_client_list(struct nfs_client *new,
712                            struct nfs_client **result,
713                            struct rpc_cred *cred)
714 {
715         struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
716         struct nfs_client *pos, *prev = NULL;
717         int status = -NFS4ERR_STALE_CLIENTID;
718
719         spin_lock(&nn->nfs_client_lock);
720         list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
721
722                 if (pos == new)
723                         goto found;
724
725                 if (pos->rpc_ops != new->rpc_ops)
726                         continue;
727
728                 if (pos->cl_minorversion != new->cl_minorversion)
729                         continue;
730
731                 /* If "pos" isn't marked ready, we can't trust the
732                  * remaining fields in "pos", especially the client
733                  * ID and serverowner fields.  Wait for CREATE_SESSION
734                  * to finish. */
735                 if (pos->cl_cons_state > NFS_CS_READY) {
736                         atomic_inc(&pos->cl_count);
737                         spin_unlock(&nn->nfs_client_lock);
738
739                         nfs_put_client(prev);
740                         prev = pos;
741
742                         status = nfs_wait_client_init_complete(pos);
743                         spin_lock(&nn->nfs_client_lock);
744                         if (status < 0)
745                                 break;
746                         status = -NFS4ERR_STALE_CLIENTID;
747                 }
748                 if (pos->cl_cons_state != NFS_CS_READY)
749                         continue;
750
751                 if (!nfs4_match_clientids(pos->cl_clientid, new->cl_clientid))
752                         continue;
753
754                 /*
755                  * Note that session trunking is just a special subcase of
756                  * client id trunking. In either case, we want to fall back
757                  * to using the existing nfs_client.
758                  */
759                 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
760                                                      new->cl_serverowner))
761                         continue;
762
763                 /* Unlike NFSv4.0, we know that NFSv4.1 always uses the
764                  * uniform string, however someone might switch the
765                  * uniquifier string on us.
766                  */
767                 if (!nfs4_match_client_owner_id(pos, new))
768                         continue;
769 found:
770                 atomic_inc(&pos->cl_count);
771                 *result = pos;
772                 status = 0;
773                 dprintk("NFS: <-- %s using nfs_client = %p ({%d})\n",
774                         __func__, pos, atomic_read(&pos->cl_count));
775                 break;
776         }
777
778         spin_unlock(&nn->nfs_client_lock);
779         dprintk("NFS: <-- %s status = %d\n", __func__, status);
780         nfs_put_client(prev);
781         return status;
782 }
783 #endif  /* CONFIG_NFS_V4_1 */
784
785 static void nfs4_destroy_server(struct nfs_server *server)
786 {
787         LIST_HEAD(freeme);
788
789         nfs_server_return_all_delegations(server);
790         unset_pnfs_layoutdriver(server);
791         nfs4_purge_state_owners(server, &freeme);
792         nfs4_free_state_owners(&freeme);
793 }
794
795 /*
796  * NFSv4.0 callback thread helper
797  *
798  * Find a client by callback identifier
799  */
800 struct nfs_client *
801 nfs4_find_client_ident(struct net *net, int cb_ident)
802 {
803         struct nfs_client *clp;
804         struct nfs_net *nn = net_generic(net, nfs_net_id);
805
806         spin_lock(&nn->nfs_client_lock);
807         clp = idr_find(&nn->cb_ident_idr, cb_ident);
808         if (clp)
809                 atomic_inc(&clp->cl_count);
810         spin_unlock(&nn->nfs_client_lock);
811         return clp;
812 }
813
814 #if defined(CONFIG_NFS_V4_1)
815 /* Common match routine for v4.0 and v4.1 callback services */
816 static bool nfs4_cb_match_client(const struct sockaddr *addr,
817                 struct nfs_client *clp, u32 minorversion)
818 {
819         struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
820
821         /* Don't match clients that failed to initialise */
822         if (!(clp->cl_cons_state == NFS_CS_READY ||
823             clp->cl_cons_state == NFS_CS_SESSION_INITING))
824                 return false;
825
826         smp_rmb();
827
828         /* Match the version and minorversion */
829         if (clp->rpc_ops->version != 4 ||
830             clp->cl_minorversion != minorversion)
831                 return false;
832
833         /* Match only the IP address, not the port number */
834         return rpc_cmp_addr(addr, clap);
835 }
836
837 /*
838  * NFSv4.1 callback thread helper
839  * For CB_COMPOUND calls, find a client by IP address, protocol version,
840  * minorversion, and sessionID
841  *
842  * Returns NULL if no such client
843  */
844 struct nfs_client *
845 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
846                            struct nfs4_sessionid *sid, u32 minorversion)
847 {
848         struct nfs_client *clp;
849         struct nfs_net *nn = net_generic(net, nfs_net_id);
850
851         spin_lock(&nn->nfs_client_lock);
852         list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
853                 if (!nfs4_cb_match_client(addr, clp, minorversion))
854                         continue;
855
856                 if (!nfs4_has_session(clp))
857                         continue;
858
859                 /* Match sessionid*/
860                 if (memcmp(clp->cl_session->sess_id.data,
861                     sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
862                         continue;
863
864                 atomic_inc(&clp->cl_count);
865                 spin_unlock(&nn->nfs_client_lock);
866                 return clp;
867         }
868         spin_unlock(&nn->nfs_client_lock);
869         return NULL;
870 }
871
872 #else /* CONFIG_NFS_V4_1 */
873
874 struct nfs_client *
875 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
876                            struct nfs4_sessionid *sid, u32 minorversion)
877 {
878         return NULL;
879 }
880 #endif /* CONFIG_NFS_V4_1 */
881
882 /*
883  * Set up an NFS4 client
884  */
885 static int nfs4_set_client(struct nfs_server *server,
886                 const char *hostname,
887                 const struct sockaddr *addr,
888                 const size_t addrlen,
889                 const char *ip_addr,
890                 rpc_authflavor_t authflavour,
891                 int proto, const struct rpc_timeout *timeparms,
892                 u32 minorversion, struct net *net)
893 {
894         struct nfs_client_initdata cl_init = {
895                 .hostname = hostname,
896                 .addr = addr,
897                 .addrlen = addrlen,
898                 .ip_addr = ip_addr,
899                 .nfs_mod = &nfs_v4,
900                 .proto = proto,
901                 .minorversion = minorversion,
902                 .net = net,
903                 .timeparms = timeparms,
904         };
905         struct nfs_client *clp;
906         int error;
907
908         dprintk("--> nfs4_set_client()\n");
909
910         if (server->flags & NFS_MOUNT_NORESVPORT)
911                 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
912         if (server->options & NFS_OPTION_MIGRATION)
913                 set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
914
915         /* Allocate or find a client reference we can use */
916         clp = nfs_get_client(&cl_init, authflavour);
917         if (IS_ERR(clp)) {
918                 error = PTR_ERR(clp);
919                 goto error;
920         }
921
922         if (server->nfs_client == clp) {
923                 error = -ELOOP;
924                 goto error;
925         }
926
927         /*
928          * Query for the lease time on clientid setup or renewal
929          *
930          * Note that this will be set on nfs_clients that were created
931          * only for the DS role and did not set this bit, but now will
932          * serve a dual role.
933          */
934         set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
935
936         server->nfs_client = clp;
937         dprintk("<-- nfs4_set_client() = 0 [new %p]\n", clp);
938         return 0;
939 error:
940         dprintk("<-- nfs4_set_client() = xerror %d\n", error);
941         return error;
942 }
943
944 /*
945  * Set up a pNFS Data Server client.
946  *
947  * Return any existing nfs_client that matches server address,port,version
948  * and minorversion.
949  *
950  * For a new nfs_client, use a soft mount (default), a low retrans and a
951  * low timeout interval so that if a connection is lost, we retry through
952  * the MDS.
953  */
954 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
955                 const struct sockaddr *ds_addr, int ds_addrlen,
956                 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
957                 u32 minor_version, rpc_authflavor_t au_flavor)
958 {
959         struct rpc_timeout ds_timeout;
960         struct nfs_client *mds_clp = mds_srv->nfs_client;
961         struct nfs_client_initdata cl_init = {
962                 .addr = ds_addr,
963                 .addrlen = ds_addrlen,
964                 .nodename = mds_clp->cl_rpcclient->cl_nodename,
965                 .ip_addr = mds_clp->cl_ipaddr,
966                 .nfs_mod = &nfs_v4,
967                 .proto = ds_proto,
968                 .minorversion = minor_version,
969                 .net = mds_clp->cl_net,
970                 .timeparms = &ds_timeout,
971         };
972         struct nfs_client *clp;
973         char buf[INET6_ADDRSTRLEN + 1];
974
975         if (rpc_ntop(ds_addr, buf, sizeof(buf)) <= 0)
976                 return ERR_PTR(-EINVAL);
977         cl_init.hostname = buf;
978
979         if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
980                 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
981
982         /*
983          * Set an authflavor equual to the MDS value. Use the MDS nfs_client
984          * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
985          * (section 13.1 RFC 5661).
986          */
987         nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
988         clp = nfs_get_client(&cl_init, au_flavor);
989
990         dprintk("<-- %s %p\n", __func__, clp);
991         return clp;
992 }
993 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
994
995 /*
996  * Session has been established, and the client marked ready.
997  * Limit the mount rsize, wsize and dtsize using negotiated fore
998  * channel attributes.
999  */
1000 static void nfs4_session_limit_rwsize(struct nfs_server *server)
1001 {
1002 #ifdef CONFIG_NFS_V4_1
1003         struct nfs4_session *sess;
1004         u32 server_resp_sz;
1005         u32 server_rqst_sz;
1006
1007         if (!nfs4_has_session(server->nfs_client))
1008                 return;
1009         sess = server->nfs_client->cl_session;
1010         server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1011         server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1012
1013         if (server->dtsize > server_resp_sz)
1014                 server->dtsize = server_resp_sz;
1015         if (server->rsize > server_resp_sz)
1016                 server->rsize = server_resp_sz;
1017         if (server->wsize > server_rqst_sz)
1018                 server->wsize = server_rqst_sz;
1019 #endif /* CONFIG_NFS_V4_1 */
1020 }
1021
1022 static int nfs4_server_common_setup(struct nfs_server *server,
1023                 struct nfs_fh *mntfh, bool auth_probe)
1024 {
1025         struct nfs_fattr *fattr;
1026         int error;
1027
1028         /* data servers support only a subset of NFSv4.1 */
1029         if (is_ds_only_client(server->nfs_client))
1030                 return -EPROTONOSUPPORT;
1031
1032         fattr = nfs_alloc_fattr();
1033         if (fattr == NULL)
1034                 return -ENOMEM;
1035
1036         /* We must ensure the session is initialised first */
1037         error = nfs4_init_session(server->nfs_client);
1038         if (error < 0)
1039                 goto out;
1040
1041         /* Set the basic capabilities */
1042         server->caps |= server->nfs_client->cl_mvops->init_caps;
1043         if (server->flags & NFS_MOUNT_NORDIRPLUS)
1044                         server->caps &= ~NFS_CAP_READDIRPLUS;
1045         /*
1046          * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1047          * authentication.
1048          */
1049         if (nfs4_disable_idmapping &&
1050                         server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1051                 server->caps |= NFS_CAP_UIDGID_NOMAP;
1052
1053
1054         /* Probe the root fh to retrieve its FSID and filehandle */
1055         error = nfs4_get_rootfh(server, mntfh, auth_probe);
1056         if (error < 0)
1057                 goto out;
1058
1059         dprintk("Server FSID: %llx:%llx\n",
1060                         (unsigned long long) server->fsid.major,
1061                         (unsigned long long) server->fsid.minor);
1062         nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1063
1064         error = nfs_probe_fsinfo(server, mntfh, fattr);
1065         if (error < 0)
1066                 goto out;
1067
1068         nfs4_session_limit_rwsize(server);
1069
1070         if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1071                 server->namelen = NFS4_MAXNAMLEN;
1072
1073         nfs_server_insert_lists(server);
1074         server->mount_time = jiffies;
1075         server->destroy = nfs4_destroy_server;
1076 out:
1077         nfs_free_fattr(fattr);
1078         return error;
1079 }
1080
1081 /*
1082  * Create a version 4 volume record
1083  */
1084 static int nfs4_init_server(struct nfs_server *server,
1085                 struct nfs_parsed_mount_data *data)
1086 {
1087         struct rpc_timeout timeparms;
1088         int error;
1089
1090         dprintk("--> nfs4_init_server()\n");
1091
1092         nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1093                         data->timeo, data->retrans);
1094
1095         /* Initialise the client representation from the mount data */
1096         server->flags = data->flags;
1097         server->options = data->options;
1098         server->auth_info = data->auth_info;
1099
1100         /* Use the first specified auth flavor. If this flavor isn't
1101          * allowed by the server, use the SECINFO path to try the
1102          * other specified flavors */
1103         if (data->auth_info.flavor_len >= 1)
1104                 data->selected_flavor = data->auth_info.flavors[0];
1105         else
1106                 data->selected_flavor = RPC_AUTH_UNIX;
1107
1108         /* Get a client record */
1109         error = nfs4_set_client(server,
1110                         data->nfs_server.hostname,
1111                         (const struct sockaddr *)&data->nfs_server.address,
1112                         data->nfs_server.addrlen,
1113                         data->client_address,
1114                         data->selected_flavor,
1115                         data->nfs_server.protocol,
1116                         &timeparms,
1117                         data->minorversion,
1118                         data->net);
1119         if (error < 0)
1120                 goto error;
1121
1122         if (data->rsize)
1123                 server->rsize = nfs_block_size(data->rsize, NULL);
1124         if (data->wsize)
1125                 server->wsize = nfs_block_size(data->wsize, NULL);
1126
1127         server->acregmin = data->acregmin * HZ;
1128         server->acregmax = data->acregmax * HZ;
1129         server->acdirmin = data->acdirmin * HZ;
1130         server->acdirmax = data->acdirmax * HZ;
1131
1132         server->port = data->nfs_server.port;
1133
1134         error = nfs_init_server_rpcclient(server, &timeparms,
1135                                           data->selected_flavor);
1136
1137 error:
1138         /* Done */
1139         dprintk("<-- nfs4_init_server() = %d\n", error);
1140         return error;
1141 }
1142
1143 /*
1144  * Create a version 4 volume record
1145  * - keyed on server and FSID
1146  */
1147 /*struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1148                                       struct nfs_fh *mntfh)*/
1149 struct nfs_server *nfs4_create_server(struct nfs_mount_info *mount_info,
1150                                       struct nfs_subversion *nfs_mod)
1151 {
1152         struct nfs_server *server;
1153         bool auth_probe;
1154         int error;
1155
1156         dprintk("--> nfs4_create_server()\n");
1157
1158         server = nfs_alloc_server();
1159         if (!server)
1160                 return ERR_PTR(-ENOMEM);
1161
1162         auth_probe = mount_info->parsed->auth_info.flavor_len < 1;
1163
1164         /* set up the general RPC client */
1165         error = nfs4_init_server(server, mount_info->parsed);
1166         if (error < 0)
1167                 goto error;
1168
1169         error = nfs4_server_common_setup(server, mount_info->mntfh, auth_probe);
1170         if (error < 0)
1171                 goto error;
1172
1173         dprintk("<-- nfs4_create_server() = %p\n", server);
1174         return server;
1175
1176 error:
1177         nfs_free_server(server);
1178         dprintk("<-- nfs4_create_server() = error %d\n", error);
1179         return ERR_PTR(error);
1180 }
1181
1182 /*
1183  * Create an NFS4 referral server record
1184  */
1185 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1186                                                struct nfs_fh *mntfh)
1187 {
1188         struct nfs_client *parent_client;
1189         struct nfs_server *server, *parent_server;
1190         bool auth_probe;
1191         int error;
1192
1193         dprintk("--> nfs4_create_referral_server()\n");
1194
1195         server = nfs_alloc_server();
1196         if (!server)
1197                 return ERR_PTR(-ENOMEM);
1198
1199         parent_server = NFS_SB(data->sb);
1200         parent_client = parent_server->nfs_client;
1201
1202         /* Initialise the client representation from the parent server */
1203         nfs_server_copy_userdata(server, parent_server);
1204
1205         /* Get a client representation.
1206          * Note: NFSv4 always uses TCP, */
1207         error = nfs4_set_client(server, data->hostname,
1208                                 data->addr,
1209                                 data->addrlen,
1210                                 parent_client->cl_ipaddr,
1211                                 data->authflavor,
1212                                 rpc_protocol(parent_server->client),
1213                                 parent_server->client->cl_timeout,
1214                                 parent_client->cl_mvops->minor_version,
1215                                 parent_client->cl_net);
1216         if (error < 0)
1217                 goto error;
1218
1219         error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1220         if (error < 0)
1221                 goto error;
1222
1223         auth_probe = parent_server->auth_info.flavor_len < 1;
1224
1225         error = nfs4_server_common_setup(server, mntfh, auth_probe);
1226         if (error < 0)
1227                 goto error;
1228
1229         dprintk("<-- nfs_create_referral_server() = %p\n", server);
1230         return server;
1231
1232 error:
1233         nfs_free_server(server);
1234         dprintk("<-- nfs4_create_referral_server() = error %d\n", error);
1235         return ERR_PTR(error);
1236 }
1237
1238 /*
1239  * Grab the destination's particulars, including lease expiry time.
1240  *
1241  * Returns zero if probe succeeded and retrieved FSID matches the FSID
1242  * we have cached.
1243  */
1244 static int nfs_probe_destination(struct nfs_server *server)
1245 {
1246         struct inode *inode = d_inode(server->super->s_root);
1247         struct nfs_fattr *fattr;
1248         int error;
1249
1250         fattr = nfs_alloc_fattr();
1251         if (fattr == NULL)
1252                 return -ENOMEM;
1253
1254         /* Sanity: the probe won't work if the destination server
1255          * does not recognize the migrated FH. */
1256         error = nfs_probe_fsinfo(server, NFS_FH(inode), fattr);
1257
1258         nfs_free_fattr(fattr);
1259         return error;
1260 }
1261
1262 /**
1263  * nfs4_update_server - Move an nfs_server to a different nfs_client
1264  *
1265  * @server: represents FSID to be moved
1266  * @hostname: new end-point's hostname
1267  * @sap: new end-point's socket address
1268  * @salen: size of "sap"
1269  * @net: net namespace
1270  *
1271  * The nfs_server must be quiescent before this function is invoked.
1272  * Either its session is drained (NFSv4.1+), or its transport is
1273  * plugged and drained (NFSv4.0).
1274  *
1275  * Returns zero on success, or a negative errno value.
1276  */
1277 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1278                        struct sockaddr *sap, size_t salen, struct net *net)
1279 {
1280         struct nfs_client *clp = server->nfs_client;
1281         struct rpc_clnt *clnt = server->client;
1282         struct xprt_create xargs = {
1283                 .ident          = clp->cl_proto,
1284                 .net            = net,
1285                 .dstaddr        = sap,
1286                 .addrlen        = salen,
1287                 .servername     = hostname,
1288         };
1289         char buf[INET6_ADDRSTRLEN + 1];
1290         struct sockaddr_storage address;
1291         struct sockaddr *localaddr = (struct sockaddr *)&address;
1292         int error;
1293
1294         dprintk("--> %s: move FSID %llx:%llx to \"%s\")\n", __func__,
1295                         (unsigned long long)server->fsid.major,
1296                         (unsigned long long)server->fsid.minor,
1297                         hostname);
1298
1299         error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1300         if (error != 0) {
1301                 dprintk("<-- %s(): rpc_switch_client_transport returned %d\n",
1302                         __func__, error);
1303                 goto out;
1304         }
1305
1306         error = rpc_localaddr(clnt, localaddr, sizeof(address));
1307         if (error != 0) {
1308                 dprintk("<-- %s(): rpc_localaddr returned %d\n",
1309                         __func__, error);
1310                 goto out;
1311         }
1312
1313         error = -EAFNOSUPPORT;
1314         if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0) {
1315                 dprintk("<-- %s(): rpc_ntop returned %d\n",
1316                         __func__, error);
1317                 goto out;
1318         }
1319
1320         nfs_server_remove_lists(server);
1321         error = nfs4_set_client(server, hostname, sap, salen, buf,
1322                                 clp->cl_rpcclient->cl_auth->au_flavor,
1323                                 clp->cl_proto, clnt->cl_timeout,
1324                                 clp->cl_minorversion, net);
1325         nfs_put_client(clp);
1326         if (error != 0) {
1327                 nfs_server_insert_lists(server);
1328                 dprintk("<-- %s(): nfs4_set_client returned %d\n",
1329                         __func__, error);
1330                 goto out;
1331         }
1332
1333         if (server->nfs_client->cl_hostname == NULL) {
1334                 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1335                 if (server->nfs_client->cl_hostname == NULL)
1336                         return -ENOMEM;
1337         }
1338         nfs_server_insert_lists(server);
1339
1340         error = nfs_probe_destination(server);
1341         if (error < 0)
1342                 goto out;
1343
1344         dprintk("<-- %s() succeeded\n", __func__);
1345
1346 out:
1347         return error;
1348 }