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