1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
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_mvops = nfs_v4_minor_ops[cl_init->minorversion];
221 #if IS_ENABLED(CONFIG_NFS_V4_1)
222 init_waitqueue_head(&clp->cl_lock_waitq);
224 INIT_LIST_HEAD(&clp->pending_cb_stateids);
228 nfs_free_client(clp);
233 * Destroy the NFS4 callback service
235 static void nfs4_destroy_callback(struct nfs_client *clp)
237 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
238 nfs_callback_down(clp->cl_mvops->minor_version, clp->cl_net);
241 static void nfs4_shutdown_client(struct nfs_client *clp)
243 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
244 nfs4_kill_renewd(clp);
245 clp->cl_mvops->shutdown_client(clp);
246 nfs4_destroy_callback(clp);
247 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
248 nfs_idmap_delete(clp);
250 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
251 kfree(clp->cl_serverowner);
252 kfree(clp->cl_serverscope);
253 kfree(clp->cl_implid);
254 kfree(clp->cl_owner_id);
257 void nfs4_free_client(struct nfs_client *clp)
259 nfs4_shutdown_client(clp);
260 nfs_free_client(clp);
264 * Initialize the NFS4 callback service
266 static int nfs4_init_callback(struct nfs_client *clp)
268 struct rpc_xprt *xprt;
271 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
273 if (nfs4_has_session(clp)) {
274 error = xprt_setup_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
279 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
281 dprintk("%s: failed to start callback. Error = %d\n",
285 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
291 * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
292 * @clp: nfs_client to initialize
294 * Returns zero on success, or a negative errno if some error occurred.
296 int nfs40_init_client(struct nfs_client *clp)
298 struct nfs4_slot_table *tbl;
301 tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
305 ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
306 "NFSv4.0 transport Slot table");
312 clp->cl_slot_tbl = tbl;
316 #if defined(CONFIG_NFS_V4_1)
319 * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
320 * @clp: nfs_client to initialize
322 * Returns zero on success, or a negative errno if some error occurred.
324 int nfs41_init_client(struct nfs_client *clp)
326 struct nfs4_session *session = NULL;
329 * Create the session and mark it expired.
330 * When a SEQUENCE operation encounters the expired session
331 * it will do session recovery to initialize it.
333 session = nfs4_alloc_session(clp);
337 clp->cl_session = session;
340 * The create session reply races with the server back
341 * channel probe. Mark the client NFS_CS_SESSION_INITING
342 * so that the client back channel can find the
345 nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
349 #endif /* CONFIG_NFS_V4_1 */
352 * Initialize the minor version specific parts of an NFS4 client record
354 static int nfs4_init_client_minor_version(struct nfs_client *clp)
358 ret = clp->cl_mvops->init_client(clp);
361 return nfs4_init_callback(clp);
365 * nfs4_init_client - Initialise an NFS4 client record
367 * @clp: nfs_client to initialise
368 * @cl_init: pointer to nfs_client_initdata
370 * Returns pointer to an NFS client, or an ERR_PTR value.
372 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
373 const struct nfs_client_initdata *cl_init)
375 char buf[INET6_ADDRSTRLEN + 1];
376 const char *ip_addr = cl_init->ip_addr;
377 struct nfs_client *old;
380 if (clp->cl_cons_state == NFS_CS_READY)
381 /* the client is initialised already */
384 /* Check NFS protocol revision and initialize RPC op vector */
385 clp->rpc_ops = &nfs_v4_clientops;
387 if (clp->cl_minorversion != 0)
388 __set_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags);
389 __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
390 __set_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags);
392 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_GSS_KRB5I);
393 if (error == -EINVAL)
394 error = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
398 /* If no clientaddr= option was specified, find a usable cb address */
399 if (ip_addr == NULL) {
400 struct sockaddr_storage cb_addr;
401 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
403 error = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
406 error = rpc_ntop(sap, buf, sizeof(buf));
409 ip_addr = (const char *)buf;
411 strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
413 error = nfs_idmap_new(clp);
415 dprintk("%s: failed to create idmapper. Error = %d\n",
419 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
421 error = nfs4_init_client_minor_version(clp);
425 error = nfs4_discover_server_trunking(clp, &old);
430 clp->cl_preserve_clid = true;
432 * Mark the client as having failed initialization so other
433 * processes walking the nfs_client_list in nfs_match_client()
434 * won't try to use it.
436 nfs_mark_client_ready(clp, -EPERM);
439 clear_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags);
443 nfs_mark_client_ready(clp, error);
445 return ERR_PTR(error);
449 * SETCLIENTID just did a callback update with the callback ident in
450 * "drop," but server trunking discovery claims "drop" and "keep" are
451 * actually the same server. Swap the callback IDs so that "keep"
452 * will continue to use the callback ident the server now knows about,
453 * and so that "keep"'s original callback ident is destroyed when
456 static void nfs4_swap_callback_idents(struct nfs_client *keep,
457 struct nfs_client *drop)
459 struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
460 unsigned int save = keep->cl_cb_ident;
462 if (keep->cl_cb_ident == drop->cl_cb_ident)
465 dprintk("%s: keeping callback ident %u and dropping ident %u\n",
466 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
468 spin_lock(&nn->nfs_client_lock);
470 idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
471 keep->cl_cb_ident = drop->cl_cb_ident;
473 idr_replace(&nn->cb_ident_idr, drop, save);
474 drop->cl_cb_ident = save;
476 spin_unlock(&nn->nfs_client_lock);
479 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
480 const struct nfs_client *clp2)
482 if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
484 return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
487 static bool nfs4_same_verifier(nfs4_verifier *v1, nfs4_verifier *v2)
489 return memcmp(v1->data, v2->data, sizeof(v1->data)) == 0;
492 static int nfs4_match_client(struct nfs_client *pos, struct nfs_client *new,
493 struct nfs_client **prev, struct nfs_net *nn)
497 if (pos->rpc_ops != new->rpc_ops)
500 if (pos->cl_minorversion != new->cl_minorversion)
503 /* If "pos" isn't marked ready, we can't trust the
504 * remaining fields in "pos", especially the client
505 * ID and serverowner fields. Wait for CREATE_SESSION
507 if (pos->cl_cons_state > NFS_CS_READY) {
508 refcount_inc(&pos->cl_count);
509 spin_unlock(&nn->nfs_client_lock);
511 nfs_put_client(*prev);
514 status = nfs_wait_client_init_complete(pos);
515 spin_lock(&nn->nfs_client_lock);
521 if (pos->cl_cons_state != NFS_CS_READY)
524 if (pos->cl_clientid != new->cl_clientid)
527 /* NFSv4.1 always uses the uniform string, however someone
528 * might switch the uniquifier string on us.
530 if (!nfs4_match_client_owner_id(pos, new))
537 * nfs40_walk_client_list - Find server that recognizes a client ID
539 * @new: nfs_client with client ID to test
540 * @result: OUT: found nfs_client, or new
541 * @cred: credential to use for trunking test
543 * Returns zero, a negative errno, or a negative NFS4ERR status.
544 * If zero is returned, an nfs_client pointer is planted in "result."
546 * NB: nfs40_walk_client_list() relies on the new nfs_client being
547 * the last nfs_client on the list.
549 int nfs40_walk_client_list(struct nfs_client *new,
550 struct nfs_client **result,
551 const struct cred *cred)
553 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
554 struct nfs_client *pos, *prev = NULL;
555 struct nfs4_setclientid_res clid = {
556 .clientid = new->cl_clientid,
557 .confirm = new->cl_confirm,
559 int status = -NFS4ERR_STALE_CLIENTID;
561 spin_lock(&nn->nfs_client_lock);
562 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
567 status = nfs4_match_client(pos, new, &prev, nn);
573 * We just sent a new SETCLIENTID, which should have
574 * caused the server to return a new cl_confirm. So if
575 * cl_confirm is the same, then this is a different
576 * server that just returned the same cl_confirm by
579 if ((new != pos) && nfs4_same_verifier(&pos->cl_confirm,
583 * But if the cl_confirm's are different, then the only
584 * way that a SETCLIENTID_CONFIRM to pos can succeed is
585 * if new and pos point to the same server:
588 refcount_inc(&pos->cl_count);
589 spin_unlock(&nn->nfs_client_lock);
591 nfs_put_client(prev);
594 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
596 case -NFS4ERR_STALE_CLIENTID:
599 nfs4_swap_callback_idents(pos, new);
600 pos->cl_confirm = new->cl_confirm;
601 nfs_mark_client_ready(pos, NFS_CS_READY);
608 /* The callback path may have been inadvertently
609 * changed. Schedule recovery!
611 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)
763 nfs_server_return_all_delegations(server);
764 unset_pnfs_layoutdriver(server);
765 nfs4_purge_state_owners(server, &freeme);
766 nfs4_free_state_owners(&freeme);
770 * NFSv4.0 callback thread helper
772 * Find a client by callback identifier
775 nfs4_find_client_ident(struct net *net, int cb_ident)
777 struct nfs_client *clp;
778 struct nfs_net *nn = net_generic(net, nfs_net_id);
780 spin_lock(&nn->nfs_client_lock);
781 clp = idr_find(&nn->cb_ident_idr, cb_ident);
783 refcount_inc(&clp->cl_count);
784 spin_unlock(&nn->nfs_client_lock);
788 #if defined(CONFIG_NFS_V4_1)
789 /* Common match routine for v4.0 and v4.1 callback services */
790 static bool nfs4_cb_match_client(const struct sockaddr *addr,
791 struct nfs_client *clp, u32 minorversion)
793 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
795 /* Don't match clients that failed to initialise */
796 if (!(clp->cl_cons_state == NFS_CS_READY ||
797 clp->cl_cons_state == NFS_CS_SESSION_INITING))
802 /* Match the version and minorversion */
803 if (clp->rpc_ops->version != 4 ||
804 clp->cl_minorversion != minorversion)
807 /* Match only the IP address, not the port number */
808 return rpc_cmp_addr(addr, clap);
812 * NFSv4.1 callback thread helper
813 * For CB_COMPOUND calls, find a client by IP address, protocol version,
814 * minorversion, and sessionID
816 * Returns NULL if no such client
819 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
820 struct nfs4_sessionid *sid, u32 minorversion)
822 struct nfs_client *clp;
823 struct nfs_net *nn = net_generic(net, nfs_net_id);
825 spin_lock(&nn->nfs_client_lock);
826 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
827 if (!nfs4_cb_match_client(addr, clp, minorversion))
830 if (!nfs4_has_session(clp))
834 if (memcmp(clp->cl_session->sess_id.data,
835 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
838 refcount_inc(&clp->cl_count);
839 spin_unlock(&nn->nfs_client_lock);
842 spin_unlock(&nn->nfs_client_lock);
846 #else /* CONFIG_NFS_V4_1 */
849 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
850 struct nfs4_sessionid *sid, u32 minorversion)
854 #endif /* CONFIG_NFS_V4_1 */
857 * Set up an NFS4 client
859 static int nfs4_set_client(struct nfs_server *server,
860 const char *hostname,
861 const struct sockaddr *addr,
862 const size_t addrlen,
864 int proto, const struct rpc_timeout *timeparms,
865 u32 minorversion, unsigned int nconnect,
868 struct nfs_client_initdata cl_init = {
869 .hostname = hostname,
875 .minorversion = minorversion,
877 .timeparms = timeparms,
878 .cred = server->cred,
880 struct nfs_client *clp;
882 if (minorversion == 0)
883 __set_bit(NFS_CS_REUSEPORT, &cl_init.init_flags);
884 if (proto == XPRT_TRANSPORT_TCP)
885 cl_init.nconnect = nconnect;
887 if (server->flags & NFS_MOUNT_NORESVPORT)
888 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
889 if (server->options & NFS_OPTION_MIGRATION)
890 __set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
891 if (test_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status))
892 __set_bit(NFS_CS_TSM_POSSIBLE, &cl_init.init_flags);
893 server->port = rpc_get_port(addr);
895 /* Allocate or find a client reference we can use */
896 clp = nfs_get_client(&cl_init);
900 if (server->nfs_client == clp) {
906 * Query for the lease time on clientid setup or renewal
908 * Note that this will be set on nfs_clients that were created
909 * only for the DS role and did not set this bit, but now will
912 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
914 server->nfs_client = clp;
919 * Set up a pNFS Data Server client.
921 * Return any existing nfs_client that matches server address,port,version
924 * For a new nfs_client, use a soft mount (default), a low retrans and a
925 * low timeout interval so that if a connection is lost, we retry through
928 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
929 const struct sockaddr *ds_addr, int ds_addrlen,
930 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
933 struct rpc_timeout ds_timeout;
934 struct nfs_client *mds_clp = mds_srv->nfs_client;
935 struct nfs_client_initdata cl_init = {
937 .addrlen = ds_addrlen,
938 .nodename = mds_clp->cl_rpcclient->cl_nodename,
939 .ip_addr = mds_clp->cl_ipaddr,
942 .minorversion = minor_version,
943 .net = mds_clp->cl_net,
944 .timeparms = &ds_timeout,
945 .cred = mds_srv->cred,
947 char buf[INET6_ADDRSTRLEN + 1];
949 if (rpc_ntop(ds_addr, buf, sizeof(buf)) <= 0)
950 return ERR_PTR(-EINVAL);
951 cl_init.hostname = buf;
953 if (mds_clp->cl_nconnect > 1 && ds_proto == XPRT_TRANSPORT_TCP)
954 cl_init.nconnect = mds_clp->cl_nconnect;
956 if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
957 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
960 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
961 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
962 * (section 13.1 RFC 5661).
964 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
965 return nfs_get_client(&cl_init);
967 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
970 * Session has been established, and the client marked ready.
971 * Limit the mount rsize, wsize and dtsize using negotiated fore
972 * channel attributes.
974 static void nfs4_session_limit_rwsize(struct nfs_server *server)
976 #ifdef CONFIG_NFS_V4_1
977 struct nfs4_session *sess;
981 if (!nfs4_has_session(server->nfs_client))
983 sess = server->nfs_client->cl_session;
984 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
985 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
987 if (server->dtsize > server_resp_sz)
988 server->dtsize = server_resp_sz;
989 if (server->rsize > server_resp_sz)
990 server->rsize = server_resp_sz;
991 if (server->wsize > server_rqst_sz)
992 server->wsize = server_rqst_sz;
993 #endif /* CONFIG_NFS_V4_1 */
997 * Limit xattr sizes using the channel attributes.
999 static void nfs4_session_limit_xasize(struct nfs_server *server)
1001 #ifdef CONFIG_NFS_V4_2
1002 struct nfs4_session *sess;
1007 if (!nfs4_has_session(server->nfs_client))
1010 sess = server->nfs_client->cl_session;
1012 server_gxa_sz = sess->fc_attrs.max_resp_sz - nfs42_maxgetxattr_overhead;
1013 server_sxa_sz = sess->fc_attrs.max_rqst_sz - nfs42_maxsetxattr_overhead;
1014 server_lxa_sz = sess->fc_attrs.max_resp_sz -
1015 nfs42_maxlistxattrs_overhead;
1017 if (server->gxasize > server_gxa_sz)
1018 server->gxasize = server_gxa_sz;
1019 if (server->sxasize > server_sxa_sz)
1020 server->sxasize = server_sxa_sz;
1021 if (server->lxasize > server_lxa_sz)
1022 server->lxasize = server_lxa_sz;
1026 static int nfs4_server_common_setup(struct nfs_server *server,
1027 struct nfs_fh *mntfh, bool auth_probe)
1029 struct nfs_fattr *fattr;
1032 /* data servers support only a subset of NFSv4.1 */
1033 if (is_ds_only_client(server->nfs_client))
1034 return -EPROTONOSUPPORT;
1036 fattr = nfs_alloc_fattr();
1040 /* We must ensure the session is initialised first */
1041 error = nfs4_init_session(server->nfs_client);
1045 /* Set the basic capabilities */
1046 server->caps |= server->nfs_client->cl_mvops->init_caps;
1047 if (server->flags & NFS_MOUNT_NORDIRPLUS)
1048 server->caps &= ~NFS_CAP_READDIRPLUS;
1049 if (server->nfs_client->cl_proto == XPRT_TRANSPORT_RDMA)
1050 server->caps &= ~NFS_CAP_READ_PLUS;
1052 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1055 if (nfs4_disable_idmapping &&
1056 server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1057 server->caps |= NFS_CAP_UIDGID_NOMAP;
1060 /* Probe the root fh to retrieve its FSID and filehandle */
1061 error = nfs4_get_rootfh(server, mntfh, auth_probe);
1065 dprintk("Server FSID: %llx:%llx\n",
1066 (unsigned long long) server->fsid.major,
1067 (unsigned long long) server->fsid.minor);
1068 nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1070 error = nfs_probe_fsinfo(server, mntfh, fattr);
1074 nfs4_session_limit_rwsize(server);
1075 nfs4_session_limit_xasize(server);
1077 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1078 server->namelen = NFS4_MAXNAMLEN;
1080 nfs_server_insert_lists(server);
1081 server->mount_time = jiffies;
1082 server->destroy = nfs4_destroy_server;
1084 nfs_free_fattr(fattr);
1089 * Create a version 4 volume record
1091 static int nfs4_init_server(struct nfs_server *server, struct fs_context *fc)
1093 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1094 struct rpc_timeout timeparms;
1097 nfs_init_timeout_values(&timeparms, ctx->nfs_server.protocol,
1098 ctx->timeo, ctx->retrans);
1100 /* Initialise the client representation from the mount data */
1101 server->flags = ctx->flags;
1102 server->options = ctx->options;
1103 server->auth_info = ctx->auth_info;
1105 /* Use the first specified auth flavor. If this flavor isn't
1106 * allowed by the server, use the SECINFO path to try the
1107 * other specified flavors */
1108 if (ctx->auth_info.flavor_len >= 1)
1109 ctx->selected_flavor = ctx->auth_info.flavors[0];
1111 ctx->selected_flavor = RPC_AUTH_UNIX;
1113 /* Get a client record */
1114 error = nfs4_set_client(server,
1115 ctx->nfs_server.hostname,
1116 &ctx->nfs_server.address,
1117 ctx->nfs_server.addrlen,
1118 ctx->client_address,
1119 ctx->nfs_server.protocol,
1122 ctx->nfs_server.nconnect,
1128 server->rsize = nfs_block_size(ctx->rsize, NULL);
1130 server->wsize = nfs_block_size(ctx->wsize, NULL);
1132 server->acregmin = ctx->acregmin * HZ;
1133 server->acregmax = ctx->acregmax * HZ;
1134 server->acdirmin = ctx->acdirmin * HZ;
1135 server->acdirmax = ctx->acdirmax * HZ;
1136 server->port = ctx->nfs_server.port;
1138 return nfs_init_server_rpcclient(server, &timeparms,
1139 ctx->selected_flavor);
1143 * Create a version 4 volume record
1144 * - keyed on server and FSID
1146 struct nfs_server *nfs4_create_server(struct fs_context *fc)
1148 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1149 struct nfs_server *server;
1153 server = nfs_alloc_server();
1155 return ERR_PTR(-ENOMEM);
1157 server->cred = get_cred(fc->cred);
1159 auth_probe = ctx->auth_info.flavor_len < 1;
1161 /* set up the general RPC client */
1162 error = nfs4_init_server(server, fc);
1166 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1173 nfs_free_server(server);
1174 return ERR_PTR(error);
1178 * Create an NFS4 referral server record
1180 struct nfs_server *nfs4_create_referral_server(struct fs_context *fc)
1182 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1183 struct nfs_client *parent_client;
1184 struct nfs_server *server, *parent_server;
1188 server = nfs_alloc_server();
1190 return ERR_PTR(-ENOMEM);
1192 parent_server = NFS_SB(ctx->clone_data.sb);
1193 parent_client = parent_server->nfs_client;
1195 server->cred = get_cred(parent_server->cred);
1197 /* Initialise the client representation from the parent server */
1198 nfs_server_copy_userdata(server, parent_server);
1200 /* Get a client representation */
1201 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1202 rpc_set_port(&ctx->nfs_server.address, NFS_RDMA_PORT);
1203 error = nfs4_set_client(server,
1204 ctx->nfs_server.hostname,
1205 &ctx->nfs_server.address,
1206 ctx->nfs_server.addrlen,
1207 parent_client->cl_ipaddr,
1208 XPRT_TRANSPORT_RDMA,
1209 parent_server->client->cl_timeout,
1210 parent_client->cl_mvops->minor_version,
1211 parent_client->cl_nconnect,
1212 parent_client->cl_net);
1215 #endif /* IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA) */
1217 rpc_set_port(&ctx->nfs_server.address, NFS_PORT);
1218 error = nfs4_set_client(server,
1219 ctx->nfs_server.hostname,
1220 &ctx->nfs_server.address,
1221 ctx->nfs_server.addrlen,
1222 parent_client->cl_ipaddr,
1224 parent_server->client->cl_timeout,
1225 parent_client->cl_mvops->minor_version,
1226 parent_client->cl_nconnect,
1227 parent_client->cl_net);
1231 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1234 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout,
1235 ctx->selected_flavor);
1239 auth_probe = parent_server->auth_info.flavor_len < 1;
1241 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1248 nfs_free_server(server);
1249 return ERR_PTR(error);
1253 * Grab the destination's particulars, including lease expiry time.
1255 * Returns zero if probe succeeded and retrieved FSID matches the FSID
1258 static int nfs_probe_destination(struct nfs_server *server)
1260 struct inode *inode = d_inode(server->super->s_root);
1261 struct nfs_fattr *fattr;
1264 fattr = nfs_alloc_fattr();
1268 /* Sanity: the probe won't work if the destination server
1269 * does not recognize the migrated FH. */
1270 error = nfs_probe_fsinfo(server, NFS_FH(inode), fattr);
1272 nfs_free_fattr(fattr);
1277 * nfs4_update_server - Move an nfs_server to a different nfs_client
1279 * @server: represents FSID to be moved
1280 * @hostname: new end-point's hostname
1281 * @sap: new end-point's socket address
1282 * @salen: size of "sap"
1283 * @net: net namespace
1285 * The nfs_server must be quiescent before this function is invoked.
1286 * Either its session is drained (NFSv4.1+), or its transport is
1287 * plugged and drained (NFSv4.0).
1289 * Returns zero on success, or a negative errno value.
1291 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1292 struct sockaddr *sap, size_t salen, struct net *net)
1294 struct nfs_client *clp = server->nfs_client;
1295 struct rpc_clnt *clnt = server->client;
1296 struct xprt_create xargs = {
1297 .ident = clp->cl_proto,
1301 .servername = hostname,
1303 char buf[INET6_ADDRSTRLEN + 1];
1304 struct sockaddr_storage address;
1305 struct sockaddr *localaddr = (struct sockaddr *)&address;
1308 error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1312 error = rpc_localaddr(clnt, localaddr, sizeof(address));
1316 if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0)
1317 return -EAFNOSUPPORT;
1319 nfs_server_remove_lists(server);
1320 set_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1321 error = nfs4_set_client(server, hostname, sap, salen, buf,
1322 clp->cl_proto, clnt->cl_timeout,
1323 clp->cl_minorversion,
1324 clp->cl_nconnect, net);
1325 clear_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1327 nfs_server_insert_lists(server);
1330 nfs_put_client(clp);
1332 if (server->nfs_client->cl_hostname == NULL)
1333 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1334 nfs_server_insert_lists(server);
1336 return nfs_probe_destination(server);