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