1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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>
16 #include "delegation.h"
17 #include "nfs4session.h"
18 #include "nfs4idmap.h"
22 #define NFSDBG_FACILITY NFSDBG_CLIENT
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
28 static int nfs_get_cb_ident_idr(struct nfs_client *clp, int minorversion)
31 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
33 if (clp->rpc_ops->version != 4 || minorversion != 0)
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);
39 clp->cl_cb_ident = ret;
40 spin_unlock(&nn->nfs_client_lock);
42 return ret < 0 ? ret : 0;
45 #ifdef CONFIG_NFS_V4_1
47 * Per auth flavor data server rpc clients
49 struct nfs4_ds_server {
50 struct list_head list; /* ds_clp->cl_ds_clients */
51 struct rpc_clnt *rpc_clnt;
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
59 static struct nfs4_ds_server *
60 nfs4_find_ds_client(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
62 struct nfs4_ds_server *dss;
65 list_for_each_entry_rcu(dss, &ds_clp->cl_ds_clients, list) {
66 if (dss->rpc_clnt->cl_auth->au_flavor != flavor)
76 static struct nfs4_ds_server *
77 nfs4_add_ds_client(struct nfs_client *ds_clp, rpc_authflavor_t flavor,
78 struct nfs4_ds_server *new)
80 struct nfs4_ds_server *dss;
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)
89 list_add_rcu(&new->list, &ds_clp->cl_ds_clients);
92 spin_unlock(&ds_clp->cl_lock); /* need some lock to protect list */
96 static struct nfs4_ds_server *
97 nfs4_alloc_ds_server(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
99 struct nfs4_ds_server *dss;
101 dss = kmalloc(sizeof(*dss), GFP_NOFS);
103 return ERR_PTR(-ENOMEM);
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);
111 INIT_LIST_HEAD(&dss->list);
117 nfs4_free_ds_server(struct nfs4_ds_server *dss)
119 rpc_release_client(dss->rpc_clnt);
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
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.
132 nfs4_find_or_create_ds_client(struct nfs_client *ds_clp, struct inode *inode)
134 struct nfs4_ds_server *dss, *new;
135 rpc_authflavor_t flavor = NFS_SERVER(inode)->client->cl_auth->au_flavor;
137 dss = nfs4_find_ds_client(ds_clp, flavor);
140 new = nfs4_alloc_ds_server(ds_clp, flavor);
142 return ERR_CAST(new);
143 dss = nfs4_add_ds_client(ds_clp, flavor, new);
145 nfs4_free_ds_server(new);
147 return dss->rpc_clnt;
149 EXPORT_SYMBOL_GPL(nfs4_find_or_create_ds_client);
152 nfs4_shutdown_ds_clients(struct nfs_client *clp)
154 struct nfs4_ds_server *dss;
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);
166 nfs4_cleanup_callback(struct nfs_client *clp)
168 struct nfs4_copy_state *cp_state;
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);
178 void nfs41_shutdown_client(struct nfs_client *clp)
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);
188 #endif /* CONFIG_NFS_V4_1 */
190 void nfs40_shutdown_client(struct nfs_client *clp)
192 if (clp->cl_slot_tbl) {
193 nfs4_shutdown_slot_table(clp->cl_slot_tbl);
194 kfree(clp->cl_slot_tbl);
198 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *cl_init)
201 struct nfs_client *clp = nfs_alloc_client(cl_init);
205 err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
209 if (cl_init->minorversion > NFS4_MAX_MINOR_VERSION) {
214 spin_lock_init(&clp->cl_lock);
215 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
216 INIT_LIST_HEAD(&clp->cl_ds_clients);
217 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
218 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
219 clp->cl_minorversion = cl_init->minorversion;
220 clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
222 #if IS_ENABLED(CONFIG_NFS_V4_1)
223 init_waitqueue_head(&clp->cl_lock_waitq);
225 INIT_LIST_HEAD(&clp->pending_cb_stateids);
229 nfs_free_client(clp);
234 * Destroy the NFS4 callback service
236 static void nfs4_destroy_callback(struct nfs_client *clp)
238 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
239 nfs_callback_down(clp->cl_mvops->minor_version, clp->cl_net);
242 static void nfs4_shutdown_client(struct nfs_client *clp)
244 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
245 nfs4_kill_renewd(clp);
246 clp->cl_mvops->shutdown_client(clp);
247 nfs4_destroy_callback(clp);
248 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
249 nfs_idmap_delete(clp);
251 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
252 kfree(clp->cl_serverowner);
253 kfree(clp->cl_serverscope);
254 kfree(clp->cl_implid);
255 kfree(clp->cl_owner_id);
258 void nfs4_free_client(struct nfs_client *clp)
260 nfs4_shutdown_client(clp);
261 nfs_free_client(clp);
265 * Initialize the NFS4 callback service
267 static int nfs4_init_callback(struct nfs_client *clp)
269 struct rpc_xprt *xprt;
272 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
274 if (nfs4_has_session(clp)) {
275 error = xprt_setup_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
280 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
282 dprintk("%s: failed to start callback. Error = %d\n",
286 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
292 * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
293 * @clp: nfs_client to initialize
295 * Returns zero on success, or a negative errno if some error occurred.
297 int nfs40_init_client(struct nfs_client *clp)
299 struct nfs4_slot_table *tbl;
302 tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
306 ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
307 "NFSv4.0 transport Slot table");
313 clp->cl_slot_tbl = tbl;
317 #if defined(CONFIG_NFS_V4_1)
320 * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
321 * @clp: nfs_client to initialize
323 * Returns zero on success, or a negative errno if some error occurred.
325 int nfs41_init_client(struct nfs_client *clp)
327 struct nfs4_session *session = NULL;
330 * Create the session and mark it expired.
331 * When a SEQUENCE operation encounters the expired session
332 * it will do session recovery to initialize it.
334 session = nfs4_alloc_session(clp);
338 clp->cl_session = session;
341 * The create session reply races with the server back
342 * channel probe. Mark the client NFS_CS_SESSION_INITING
343 * so that the client back channel can find the
346 nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
350 #endif /* CONFIG_NFS_V4_1 */
353 * Initialize the minor version specific parts of an NFS4 client record
355 static int nfs4_init_client_minor_version(struct nfs_client *clp)
359 ret = clp->cl_mvops->init_client(clp);
362 return nfs4_init_callback(clp);
366 * nfs4_init_client - Initialise an NFS4 client record
368 * @clp: nfs_client to initialise
369 * @cl_init: pointer to nfs_client_initdata
371 * Returns pointer to an NFS client, or an ERR_PTR value.
373 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
374 const struct nfs_client_initdata *cl_init)
376 char buf[INET6_ADDRSTRLEN + 1];
377 const char *ip_addr = cl_init->ip_addr;
378 struct nfs_client *old;
381 if (clp->cl_cons_state == NFS_CS_READY)
382 /* the client is initialised already */
385 /* Check NFS protocol revision and initialize RPC op vector */
386 clp->rpc_ops = &nfs_v4_clientops;
388 if (clp->cl_minorversion != 0)
389 __set_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags);
390 __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
391 __set_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags);
393 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_GSS_KRB5I);
394 if (error == -EINVAL)
395 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
399 /* If no clientaddr= option was specified, find a usable cb address */
400 if (ip_addr == NULL) {
401 struct sockaddr_storage cb_addr;
402 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
404 error = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
407 error = rpc_ntop(sap, buf, sizeof(buf));
410 ip_addr = (const char *)buf;
412 strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
414 error = nfs_idmap_new(clp);
416 dprintk("%s: failed to create idmapper. Error = %d\n",
420 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
422 error = nfs4_init_client_minor_version(clp);
426 error = nfs4_discover_server_trunking(clp, &old);
431 clp->cl_preserve_clid = true;
433 * Mark the client as having failed initialization so other
434 * processes walking the nfs_client_list in nfs_match_client()
435 * won't try to use it.
437 nfs_mark_client_ready(clp, -EPERM);
440 clear_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags);
444 nfs_mark_client_ready(clp, error);
446 return ERR_PTR(error);
450 * SETCLIENTID just did a callback update with the callback ident in
451 * "drop," but server trunking discovery claims "drop" and "keep" are
452 * actually the same server. Swap the callback IDs so that "keep"
453 * will continue to use the callback ident the server now knows about,
454 * and so that "keep"'s original callback ident is destroyed when
457 static void nfs4_swap_callback_idents(struct nfs_client *keep,
458 struct nfs_client *drop)
460 struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
461 unsigned int save = keep->cl_cb_ident;
463 if (keep->cl_cb_ident == drop->cl_cb_ident)
466 dprintk("%s: keeping callback ident %u and dropping ident %u\n",
467 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
469 spin_lock(&nn->nfs_client_lock);
471 idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
472 keep->cl_cb_ident = drop->cl_cb_ident;
474 idr_replace(&nn->cb_ident_idr, drop, save);
475 drop->cl_cb_ident = save;
477 spin_unlock(&nn->nfs_client_lock);
480 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
481 const struct nfs_client *clp2)
483 if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
485 return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
488 static bool nfs4_same_verifier(nfs4_verifier *v1, nfs4_verifier *v2)
490 return memcmp(v1->data, v2->data, sizeof(v1->data)) == 0;
493 static int nfs4_match_client(struct nfs_client *pos, struct nfs_client *new,
494 struct nfs_client **prev, struct nfs_net *nn)
498 if (pos->rpc_ops != new->rpc_ops)
501 if (pos->cl_minorversion != new->cl_minorversion)
504 /* If "pos" isn't marked ready, we can't trust the
505 * remaining fields in "pos", especially the client
506 * ID and serverowner fields. Wait for CREATE_SESSION
508 if (pos->cl_cons_state > NFS_CS_READY) {
509 refcount_inc(&pos->cl_count);
510 spin_unlock(&nn->nfs_client_lock);
512 nfs_put_client(*prev);
515 status = nfs_wait_client_init_complete(pos);
516 spin_lock(&nn->nfs_client_lock);
522 if (pos->cl_cons_state != NFS_CS_READY)
525 if (pos->cl_clientid != new->cl_clientid)
528 /* NFSv4.1 always uses the uniform string, however someone
529 * might switch the uniquifier string on us.
531 if (!nfs4_match_client_owner_id(pos, new))
538 * nfs40_walk_client_list - Find server that recognizes a client ID
540 * @new: nfs_client with client ID to test
541 * @result: OUT: found nfs_client, or new
542 * @cred: credential to use for trunking test
544 * Returns zero, a negative errno, or a negative NFS4ERR status.
545 * If zero is returned, an nfs_client pointer is planted in "result."
547 * NB: nfs40_walk_client_list() relies on the new nfs_client being
548 * the last nfs_client on the list.
550 int nfs40_walk_client_list(struct nfs_client *new,
551 struct nfs_client **result,
552 const struct cred *cred)
554 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
555 struct nfs_client *pos, *prev = NULL;
556 struct nfs4_setclientid_res clid = {
557 .clientid = new->cl_clientid,
558 .confirm = new->cl_confirm,
560 int status = -NFS4ERR_STALE_CLIENTID;
562 spin_lock(&nn->nfs_client_lock);
563 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
568 status = nfs4_match_client(pos, new, &prev, nn);
574 * We just sent a new SETCLIENTID, which should have
575 * caused the server to return a new cl_confirm. So if
576 * cl_confirm is the same, then this is a different
577 * server that just returned the same cl_confirm by
580 if ((new != pos) && nfs4_same_verifier(&pos->cl_confirm,
584 * But if the cl_confirm's are different, then the only
585 * way that a SETCLIENTID_CONFIRM to pos can succeed is
586 * if new and pos point to the same server:
589 refcount_inc(&pos->cl_count);
590 spin_unlock(&nn->nfs_client_lock);
592 nfs_put_client(prev);
595 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
597 case -NFS4ERR_STALE_CLIENTID:
600 nfs4_swap_callback_idents(pos, new);
601 pos->cl_confirm = new->cl_confirm;
602 nfs_mark_client_ready(pos, NFS_CS_READY);
609 /* The callback path may have been inadvertently
610 * changed. Schedule recovery!
612 nfs4_schedule_path_down_recovery(pos);
617 spin_lock(&nn->nfs_client_lock);
620 spin_unlock(&nn->nfs_client_lock);
622 /* No match found. The server lost our clientid */
624 nfs_put_client(prev);
628 #ifdef CONFIG_NFS_V4_1
630 * Returns true if the server major ids match
633 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
634 struct nfs41_server_owner *o2)
636 if (o1->major_id_sz != o2->major_id_sz)
638 return memcmp(o1->major_id, o2->major_id, o1->major_id_sz) == 0;
642 * Returns true if the server scopes match
645 nfs4_check_server_scope(struct nfs41_server_scope *s1,
646 struct nfs41_server_scope *s2)
648 if (s1->server_scope_sz != s2->server_scope_sz)
650 return memcmp(s1->server_scope, s2->server_scope,
651 s1->server_scope_sz) == 0;
655 * nfs4_detect_session_trunking - Checks for session trunking.
656 * @clp: original mount nfs_client
657 * @res: result structure from an exchange_id using the original mount
658 * nfs_client with a new multi_addr transport
659 * @xprt: pointer to the transport to add.
661 * Called after a successful EXCHANGE_ID on a multi-addr connection.
662 * Upon success, add the transport.
664 * Returns zero on success, otherwise -EINVAL
666 * Note: since the exchange_id for the new multi_addr transport uses the
667 * same nfs_client from the original mount, the cl_owner_id is reused,
668 * so eir_clientowner is the same.
670 int nfs4_detect_session_trunking(struct nfs_client *clp,
671 struct nfs41_exchange_id_res *res,
672 struct rpc_xprt *xprt)
674 /* Check eir_clientid */
675 if (clp->cl_clientid != res->clientid)
678 /* Check eir_server_owner so_major_id */
679 if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
683 /* Check eir_server_owner so_minor_id */
684 if (clp->cl_serverowner->minor_id != res->server_owner->minor_id)
687 /* Check eir_server_scope */
688 if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
691 pr_info("NFS: %s: Session trunking succeeded for %s\n",
693 xprt->address_strings[RPC_DISPLAY_ADDR]);
697 pr_info("NFS: %s: Session trunking failed for %s\n", clp->cl_hostname,
698 xprt->address_strings[RPC_DISPLAY_ADDR]);
704 * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
706 * @new: nfs_client with client ID to test
707 * @result: OUT: found nfs_client, or new
708 * @cred: credential to use for trunking test
710 * Returns zero, a negative errno, or a negative NFS4ERR status.
711 * If zero is returned, an nfs_client pointer is planted in "result."
713 * NB: nfs41_walk_client_list() relies on the new nfs_client being
714 * the last nfs_client on the list.
716 int nfs41_walk_client_list(struct nfs_client *new,
717 struct nfs_client **result,
718 const struct cred *cred)
720 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
721 struct nfs_client *pos, *prev = NULL;
722 int status = -NFS4ERR_STALE_CLIENTID;
724 spin_lock(&nn->nfs_client_lock);
725 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
730 status = nfs4_match_client(pos, new, &prev, nn);
737 * Note that session trunking is just a special subcase of
738 * client id trunking. In either case, we want to fall back
739 * to using the existing nfs_client.
741 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
742 new->cl_serverowner))
746 refcount_inc(&pos->cl_count);
753 spin_unlock(&nn->nfs_client_lock);
754 nfs_put_client(prev);
757 #endif /* CONFIG_NFS_V4_1 */
759 static void nfs4_destroy_server(struct nfs_server *server)
761 nfs_server_return_all_delegations(server);
762 unset_pnfs_layoutdriver(server);
763 nfs4_purge_state_owners(server);
767 * NFSv4.0 callback thread helper
769 * Find a client by callback identifier
772 nfs4_find_client_ident(struct net *net, int cb_ident)
774 struct nfs_client *clp;
775 struct nfs_net *nn = net_generic(net, nfs_net_id);
777 spin_lock(&nn->nfs_client_lock);
778 clp = idr_find(&nn->cb_ident_idr, cb_ident);
780 refcount_inc(&clp->cl_count);
781 spin_unlock(&nn->nfs_client_lock);
785 #if defined(CONFIG_NFS_V4_1)
786 /* Common match routine for v4.0 and v4.1 callback services */
787 static bool nfs4_cb_match_client(const struct sockaddr *addr,
788 struct nfs_client *clp, u32 minorversion)
790 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
792 /* Don't match clients that failed to initialise */
793 if (!(clp->cl_cons_state == NFS_CS_READY ||
794 clp->cl_cons_state == NFS_CS_SESSION_INITING))
799 /* Match the version and minorversion */
800 if (clp->rpc_ops->version != 4 ||
801 clp->cl_minorversion != minorversion)
804 /* Match only the IP address, not the port number */
805 return rpc_cmp_addr(addr, clap);
809 * NFSv4.1 callback thread helper
810 * For CB_COMPOUND calls, find a client by IP address, protocol version,
811 * minorversion, and sessionID
813 * Returns NULL if no such client
816 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
817 struct nfs4_sessionid *sid, u32 minorversion)
819 struct nfs_client *clp;
820 struct nfs_net *nn = net_generic(net, nfs_net_id);
822 spin_lock(&nn->nfs_client_lock);
823 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
824 if (!nfs4_cb_match_client(addr, clp, minorversion))
827 if (!nfs4_has_session(clp))
831 if (memcmp(clp->cl_session->sess_id.data,
832 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
835 refcount_inc(&clp->cl_count);
836 spin_unlock(&nn->nfs_client_lock);
839 spin_unlock(&nn->nfs_client_lock);
843 #else /* CONFIG_NFS_V4_1 */
846 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
847 struct nfs4_sessionid *sid, u32 minorversion)
851 #endif /* CONFIG_NFS_V4_1 */
854 * Set up an NFS4 client
856 static int nfs4_set_client(struct nfs_server *server,
857 const char *hostname,
858 const struct sockaddr *addr,
859 const size_t addrlen,
861 int proto, const struct rpc_timeout *timeparms,
862 u32 minorversion, struct net *net)
864 struct nfs_client_initdata cl_init = {
865 .hostname = hostname,
871 .minorversion = minorversion,
873 .timeparms = timeparms,
874 .cred = server->cred,
876 struct nfs_client *clp;
878 if (server->flags & NFS_MOUNT_NORESVPORT)
879 set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
880 if (server->options & NFS_OPTION_MIGRATION)
881 set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
882 if (test_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status))
883 set_bit(NFS_CS_TSM_POSSIBLE, &cl_init.init_flags);
884 server->port = rpc_get_port(addr);
886 /* Allocate or find a client reference we can use */
887 clp = nfs_get_client(&cl_init);
891 if (server->nfs_client == clp) {
897 * Query for the lease time on clientid setup or renewal
899 * Note that this will be set on nfs_clients that were created
900 * only for the DS role and did not set this bit, but now will
903 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
905 server->nfs_client = clp;
910 * Set up a pNFS Data Server client.
912 * Return any existing nfs_client that matches server address,port,version
915 * For a new nfs_client, use a soft mount (default), a low retrans and a
916 * low timeout interval so that if a connection is lost, we retry through
919 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
920 const struct sockaddr *ds_addr, int ds_addrlen,
921 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
924 struct rpc_timeout ds_timeout;
925 struct nfs_client *mds_clp = mds_srv->nfs_client;
926 struct nfs_client_initdata cl_init = {
928 .addrlen = ds_addrlen,
929 .nodename = mds_clp->cl_rpcclient->cl_nodename,
930 .ip_addr = mds_clp->cl_ipaddr,
933 .minorversion = minor_version,
934 .net = mds_clp->cl_net,
935 .timeparms = &ds_timeout,
936 .cred = mds_srv->cred,
938 char buf[INET6_ADDRSTRLEN + 1];
940 if (rpc_ntop(ds_addr, buf, sizeof(buf)) <= 0)
941 return ERR_PTR(-EINVAL);
942 cl_init.hostname = buf;
944 if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
945 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
948 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
949 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
950 * (section 13.1 RFC 5661).
952 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
953 return nfs_get_client(&cl_init);
955 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
958 * Session has been established, and the client marked ready.
959 * Limit the mount rsize, wsize and dtsize using negotiated fore
960 * channel attributes.
962 static void nfs4_session_limit_rwsize(struct nfs_server *server)
964 #ifdef CONFIG_NFS_V4_1
965 struct nfs4_session *sess;
969 if (!nfs4_has_session(server->nfs_client))
971 sess = server->nfs_client->cl_session;
972 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
973 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
975 if (server->dtsize > server_resp_sz)
976 server->dtsize = server_resp_sz;
977 if (server->rsize > server_resp_sz)
978 server->rsize = server_resp_sz;
979 if (server->wsize > server_rqst_sz)
980 server->wsize = server_rqst_sz;
981 #endif /* CONFIG_NFS_V4_1 */
984 static int nfs4_server_common_setup(struct nfs_server *server,
985 struct nfs_fh *mntfh, bool auth_probe)
987 struct nfs_fattr *fattr;
990 /* data servers support only a subset of NFSv4.1 */
991 if (is_ds_only_client(server->nfs_client))
992 return -EPROTONOSUPPORT;
994 fattr = nfs_alloc_fattr();
998 /* We must ensure the session is initialised first */
999 error = nfs4_init_session(server->nfs_client);
1003 /* Set the basic capabilities */
1004 server->caps |= server->nfs_client->cl_mvops->init_caps;
1005 if (server->flags & NFS_MOUNT_NORDIRPLUS)
1006 server->caps &= ~NFS_CAP_READDIRPLUS;
1008 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1011 if (nfs4_disable_idmapping &&
1012 server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1013 server->caps |= NFS_CAP_UIDGID_NOMAP;
1016 /* Probe the root fh to retrieve its FSID and filehandle */
1017 error = nfs4_get_rootfh(server, mntfh, auth_probe);
1021 dprintk("Server FSID: %llx:%llx\n",
1022 (unsigned long long) server->fsid.major,
1023 (unsigned long long) server->fsid.minor);
1024 nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1026 error = nfs_probe_fsinfo(server, mntfh, fattr);
1030 nfs4_session_limit_rwsize(server);
1032 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1033 server->namelen = NFS4_MAXNAMLEN;
1035 nfs_server_insert_lists(server);
1036 server->mount_time = jiffies;
1037 server->destroy = nfs4_destroy_server;
1039 nfs_free_fattr(fattr);
1044 * Create a version 4 volume record
1046 static int nfs4_init_server(struct nfs_server *server,
1047 struct nfs_parsed_mount_data *data)
1049 struct rpc_timeout timeparms;
1052 nfs_init_timeout_values(&timeparms, data->nfs_server.protocol,
1053 data->timeo, data->retrans);
1055 /* Initialise the client representation from the mount data */
1056 server->flags = data->flags;
1057 server->options = data->options;
1058 server->auth_info = data->auth_info;
1060 /* Use the first specified auth flavor. If this flavor isn't
1061 * allowed by the server, use the SECINFO path to try the
1062 * other specified flavors */
1063 if (data->auth_info.flavor_len >= 1)
1064 data->selected_flavor = data->auth_info.flavors[0];
1066 data->selected_flavor = RPC_AUTH_UNIX;
1068 /* Get a client record */
1069 error = nfs4_set_client(server,
1070 data->nfs_server.hostname,
1071 (const struct sockaddr *)&data->nfs_server.address,
1072 data->nfs_server.addrlen,
1073 data->client_address,
1074 data->nfs_server.protocol,
1082 server->rsize = nfs_block_size(data->rsize, NULL);
1084 server->wsize = nfs_block_size(data->wsize, NULL);
1086 server->acregmin = data->acregmin * HZ;
1087 server->acregmax = data->acregmax * HZ;
1088 server->acdirmin = data->acdirmin * HZ;
1089 server->acdirmax = data->acdirmax * HZ;
1090 server->port = data->nfs_server.port;
1092 return nfs_init_server_rpcclient(server, &timeparms,
1093 data->selected_flavor);
1097 * Create a version 4 volume record
1098 * - keyed on server and FSID
1100 /*struct nfs_server *nfs4_create_server(const struct nfs_parsed_mount_data *data,
1101 struct nfs_fh *mntfh)*/
1102 struct nfs_server *nfs4_create_server(struct nfs_mount_info *mount_info,
1103 struct nfs_subversion *nfs_mod)
1105 struct nfs_server *server;
1109 server = nfs_alloc_server();
1111 return ERR_PTR(-ENOMEM);
1113 server->cred = get_cred(current_cred());
1115 auth_probe = mount_info->parsed->auth_info.flavor_len < 1;
1117 /* set up the general RPC client */
1118 error = nfs4_init_server(server, mount_info->parsed);
1122 error = nfs4_server_common_setup(server, mount_info->mntfh, auth_probe);
1129 nfs_free_server(server);
1130 return ERR_PTR(error);
1134 * Create an NFS4 referral server record
1136 struct nfs_server *nfs4_create_referral_server(struct nfs_clone_mount *data,
1137 struct nfs_fh *mntfh)
1139 struct nfs_client *parent_client;
1140 struct nfs_server *server, *parent_server;
1144 server = nfs_alloc_server();
1146 return ERR_PTR(-ENOMEM);
1148 parent_server = NFS_SB(data->sb);
1149 parent_client = parent_server->nfs_client;
1151 server->cred = get_cred(parent_server->cred);
1153 /* Initialise the client representation from the parent server */
1154 nfs_server_copy_userdata(server, parent_server);
1156 /* Get a client representation */
1157 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1158 rpc_set_port(data->addr, NFS_RDMA_PORT);
1159 error = nfs4_set_client(server, data->hostname,
1162 parent_client->cl_ipaddr,
1163 XPRT_TRANSPORT_RDMA,
1164 parent_server->client->cl_timeout,
1165 parent_client->cl_mvops->minor_version,
1166 parent_client->cl_net);
1169 #endif /* IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA) */
1171 rpc_set_port(data->addr, NFS_PORT);
1172 error = nfs4_set_client(server, data->hostname,
1175 parent_client->cl_ipaddr,
1177 parent_server->client->cl_timeout,
1178 parent_client->cl_mvops->minor_version,
1179 parent_client->cl_net);
1183 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1186 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout, data->authflavor);
1190 auth_probe = parent_server->auth_info.flavor_len < 1;
1192 error = nfs4_server_common_setup(server, mntfh, auth_probe);
1199 nfs_free_server(server);
1200 return ERR_PTR(error);
1204 * Grab the destination's particulars, including lease expiry time.
1206 * Returns zero if probe succeeded and retrieved FSID matches the FSID
1209 static int nfs_probe_destination(struct nfs_server *server)
1211 struct inode *inode = d_inode(server->super->s_root);
1212 struct nfs_fattr *fattr;
1215 fattr = nfs_alloc_fattr();
1219 /* Sanity: the probe won't work if the destination server
1220 * does not recognize the migrated FH. */
1221 error = nfs_probe_fsinfo(server, NFS_FH(inode), fattr);
1223 nfs_free_fattr(fattr);
1228 * nfs4_update_server - Move an nfs_server to a different nfs_client
1230 * @server: represents FSID to be moved
1231 * @hostname: new end-point's hostname
1232 * @sap: new end-point's socket address
1233 * @salen: size of "sap"
1234 * @net: net namespace
1236 * The nfs_server must be quiescent before this function is invoked.
1237 * Either its session is drained (NFSv4.1+), or its transport is
1238 * plugged and drained (NFSv4.0).
1240 * Returns zero on success, or a negative errno value.
1242 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1243 struct sockaddr *sap, size_t salen, struct net *net)
1245 struct nfs_client *clp = server->nfs_client;
1246 struct rpc_clnt *clnt = server->client;
1247 struct xprt_create xargs = {
1248 .ident = clp->cl_proto,
1252 .servername = hostname,
1254 char buf[INET6_ADDRSTRLEN + 1];
1255 struct sockaddr_storage address;
1256 struct sockaddr *localaddr = (struct sockaddr *)&address;
1259 error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1263 error = rpc_localaddr(clnt, localaddr, sizeof(address));
1267 if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0)
1268 return -EAFNOSUPPORT;
1270 nfs_server_remove_lists(server);
1271 set_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1272 error = nfs4_set_client(server, hostname, sap, salen, buf,
1273 clp->cl_proto, clnt->cl_timeout,
1274 clp->cl_minorversion, net);
1275 clear_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1277 nfs_server_insert_lists(server);
1280 nfs_put_client(clp);
1282 if (server->nfs_client->cl_hostname == NULL)
1283 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1284 nfs_server_insert_lists(server);
1286 return nfs_probe_destination(server);