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