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