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