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)
200 char buf[INET6_ADDRSTRLEN + 1];
201 const char *ip_addr = cl_init->ip_addr;
202 struct nfs_client *clp = nfs_alloc_client(cl_init);
208 err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
212 if (cl_init->minorversion > NFS4_MAX_MINOR_VERSION) {
217 spin_lock_init(&clp->cl_lock);
218 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
219 INIT_LIST_HEAD(&clp->cl_ds_clients);
220 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
221 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
222 clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
224 #if IS_ENABLED(CONFIG_NFS_V4_1)
225 init_waitqueue_head(&clp->cl_lock_waitq);
227 INIT_LIST_HEAD(&clp->pending_cb_stateids);
229 if (cl_init->minorversion != 0)
230 __set_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags);
231 __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
232 __set_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags);
235 * Set up the connection to the server before we add add to the
238 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_GSS_KRB5I);
240 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
244 /* If no clientaddr= option was specified, find a usable cb address */
245 if (ip_addr == NULL) {
246 struct sockaddr_storage cb_addr;
247 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
249 err = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
252 err = rpc_ntop(sap, buf, sizeof(buf));
255 ip_addr = (const char *)buf;
257 strlcpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
259 err = nfs_idmap_new(clp);
261 dprintk("%s: failed to create idmapper. Error = %d\n",
265 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
269 nfs_free_client(clp);
274 * Destroy the NFS4 callback service
276 static void nfs4_destroy_callback(struct nfs_client *clp)
278 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
279 nfs_callback_down(clp->cl_mvops->minor_version, clp->cl_net);
282 static void nfs4_shutdown_client(struct nfs_client *clp)
284 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
285 nfs4_kill_renewd(clp);
286 clp->cl_mvops->shutdown_client(clp);
287 nfs4_destroy_callback(clp);
288 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
289 nfs_idmap_delete(clp);
291 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
292 kfree(clp->cl_serverowner);
293 kfree(clp->cl_serverscope);
294 kfree(clp->cl_implid);
295 kfree(clp->cl_owner_id);
298 void nfs4_free_client(struct nfs_client *clp)
300 nfs4_shutdown_client(clp);
301 nfs_free_client(clp);
305 * Initialize the NFS4 callback service
307 static int nfs4_init_callback(struct nfs_client *clp)
309 struct rpc_xprt *xprt;
312 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
314 if (nfs4_has_session(clp)) {
315 error = xprt_setup_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
320 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
322 dprintk("%s: failed to start callback. Error = %d\n",
326 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
332 * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
333 * @clp: nfs_client to initialize
335 * Returns zero on success, or a negative errno if some error occurred.
337 int nfs40_init_client(struct nfs_client *clp)
339 struct nfs4_slot_table *tbl;
342 tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
346 ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
347 "NFSv4.0 transport Slot table");
353 clp->cl_slot_tbl = tbl;
357 #if defined(CONFIG_NFS_V4_1)
360 * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
361 * @clp: nfs_client to initialize
363 * Returns zero on success, or a negative errno if some error occurred.
365 int nfs41_init_client(struct nfs_client *clp)
367 struct nfs4_session *session = NULL;
370 * Create the session and mark it expired.
371 * When a SEQUENCE operation encounters the expired session
372 * it will do session recovery to initialize it.
374 session = nfs4_alloc_session(clp);
378 clp->cl_session = session;
381 * The create session reply races with the server back
382 * channel probe. Mark the client NFS_CS_SESSION_INITING
383 * so that the client back channel can find the
386 nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
390 #endif /* CONFIG_NFS_V4_1 */
393 * Initialize the minor version specific parts of an NFS4 client record
395 static int nfs4_init_client_minor_version(struct nfs_client *clp)
399 ret = clp->cl_mvops->init_client(clp);
402 return nfs4_init_callback(clp);
406 * nfs4_init_client - Initialise an NFS4 client record
408 * @clp: nfs_client to initialise
409 * @cl_init: pointer to nfs_client_initdata
411 * Returns pointer to an NFS client, or an ERR_PTR value.
413 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
414 const struct nfs_client_initdata *cl_init)
416 struct nfs_client *old;
419 if (clp->cl_cons_state == NFS_CS_READY)
420 /* the client is initialised already */
423 error = nfs4_init_client_minor_version(clp);
427 error = nfs4_discover_server_trunking(clp, &old);
432 clp->cl_preserve_clid = true;
434 * Mark the client as having failed initialization so other
435 * processes walking the nfs_client_list in nfs_match_client()
436 * won't try to use it.
438 nfs_mark_client_ready(clp, -EPERM);
440 clear_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags);
445 nfs_mark_client_ready(clp, error);
447 return ERR_PTR(error);
451 * SETCLIENTID just did a callback update with the callback ident in
452 * "drop," but server trunking discovery claims "drop" and "keep" are
453 * actually the same server. Swap the callback IDs so that "keep"
454 * will continue to use the callback ident the server now knows about,
455 * and so that "keep"'s original callback ident is destroyed when
458 static void nfs4_swap_callback_idents(struct nfs_client *keep,
459 struct nfs_client *drop)
461 struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
462 unsigned int save = keep->cl_cb_ident;
464 if (keep->cl_cb_ident == drop->cl_cb_ident)
467 dprintk("%s: keeping callback ident %u and dropping ident %u\n",
468 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
470 spin_lock(&nn->nfs_client_lock);
472 idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
473 keep->cl_cb_ident = drop->cl_cb_ident;
475 idr_replace(&nn->cb_ident_idr, drop, save);
476 drop->cl_cb_ident = save;
478 spin_unlock(&nn->nfs_client_lock);
481 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
482 const struct nfs_client *clp2)
484 if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
486 return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
489 static bool nfs4_same_verifier(nfs4_verifier *v1, nfs4_verifier *v2)
491 return memcmp(v1->data, v2->data, sizeof(v1->data)) == 0;
494 static int nfs4_match_client(struct nfs_client *pos, struct nfs_client *new,
495 struct nfs_client **prev, struct nfs_net *nn)
499 if (pos->rpc_ops != new->rpc_ops)
502 if (pos->cl_minorversion != new->cl_minorversion)
505 /* If "pos" isn't marked ready, we can't trust the
506 * remaining fields in "pos", especially the client
507 * ID and serverowner fields. Wait for CREATE_SESSION
509 if (pos->cl_cons_state > NFS_CS_READY) {
510 refcount_inc(&pos->cl_count);
511 spin_unlock(&nn->nfs_client_lock);
513 nfs_put_client(*prev);
516 status = nfs_wait_client_init_complete(pos);
517 spin_lock(&nn->nfs_client_lock);
523 if (pos->cl_cons_state != NFS_CS_READY)
526 if (pos->cl_clientid != new->cl_clientid)
529 /* NFSv4.1 always uses the uniform string, however someone
530 * might switch the uniquifier string on us.
532 if (!nfs4_match_client_owner_id(pos, new))
539 * nfs40_walk_client_list - Find server that recognizes a client ID
541 * @new: nfs_client with client ID to test
542 * @result: OUT: found nfs_client, or new
543 * @cred: credential to use for trunking test
545 * Returns zero, a negative errno, or a negative NFS4ERR status.
546 * If zero is returned, an nfs_client pointer is planted in "result."
548 * NB: nfs40_walk_client_list() relies on the new nfs_client being
549 * the last nfs_client on the list.
551 int nfs40_walk_client_list(struct nfs_client *new,
552 struct nfs_client **result,
553 const struct cred *cred)
555 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
556 struct nfs_client *pos, *prev = NULL;
557 struct nfs4_setclientid_res clid = {
558 .clientid = new->cl_clientid,
559 .confirm = new->cl_confirm,
561 int status = -NFS4ERR_STALE_CLIENTID;
563 spin_lock(&nn->nfs_client_lock);
564 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
569 status = nfs4_match_client(pos, new, &prev, nn);
575 * We just sent a new SETCLIENTID, which should have
576 * caused the server to return a new cl_confirm. So if
577 * cl_confirm is the same, then this is a different
578 * server that just returned the same cl_confirm by
581 if ((new != pos) && nfs4_same_verifier(&pos->cl_confirm,
585 * But if the cl_confirm's are different, then the only
586 * way that a SETCLIENTID_CONFIRM to pos can succeed is
587 * if new and pos point to the same server:
590 refcount_inc(&pos->cl_count);
591 spin_unlock(&nn->nfs_client_lock);
593 nfs_put_client(prev);
596 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
598 case -NFS4ERR_STALE_CLIENTID:
601 nfs4_swap_callback_idents(pos, new);
602 pos->cl_confirm = new->cl_confirm;
603 nfs_mark_client_ready(pos, NFS_CS_READY);
610 /* The callback path may have been inadvertently
611 * changed. Schedule recovery!
613 nfs4_schedule_path_down_recovery(pos);
618 spin_lock(&nn->nfs_client_lock);
621 spin_unlock(&nn->nfs_client_lock);
623 /* No match found. The server lost our clientid */
625 nfs_put_client(prev);
629 #ifdef CONFIG_NFS_V4_1
631 * Returns true if the server major ids match
634 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
635 struct nfs41_server_owner *o2)
637 if (o1->major_id_sz != o2->major_id_sz)
639 return memcmp(o1->major_id, o2->major_id, o1->major_id_sz) == 0;
643 * Returns true if the server scopes match
646 nfs4_check_server_scope(struct nfs41_server_scope *s1,
647 struct nfs41_server_scope *s2)
649 if (s1->server_scope_sz != s2->server_scope_sz)
651 return memcmp(s1->server_scope, s2->server_scope,
652 s1->server_scope_sz) == 0;
656 * nfs4_detect_session_trunking - Checks for session trunking.
657 * @clp: original mount nfs_client
658 * @res: result structure from an exchange_id using the original mount
659 * nfs_client with a new multi_addr transport
660 * @xprt: pointer to the transport to add.
662 * Called after a successful EXCHANGE_ID on a multi-addr connection.
663 * Upon success, add the transport.
665 * Returns zero on success, otherwise -EINVAL
667 * Note: since the exchange_id for the new multi_addr transport uses the
668 * same nfs_client from the original mount, the cl_owner_id is reused,
669 * so eir_clientowner is the same.
671 int nfs4_detect_session_trunking(struct nfs_client *clp,
672 struct nfs41_exchange_id_res *res,
673 struct rpc_xprt *xprt)
675 /* Check eir_clientid */
676 if (clp->cl_clientid != res->clientid)
679 /* Check eir_server_owner so_major_id */
680 if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
684 /* Check eir_server_owner so_minor_id */
685 if (clp->cl_serverowner->minor_id != res->server_owner->minor_id)
688 /* Check eir_server_scope */
689 if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
692 pr_info("NFS: %s: Session trunking succeeded for %s\n",
694 xprt->address_strings[RPC_DISPLAY_ADDR]);
698 pr_info("NFS: %s: Session trunking failed for %s\n", clp->cl_hostname,
699 xprt->address_strings[RPC_DISPLAY_ADDR]);
705 * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
707 * @new: nfs_client with client ID to test
708 * @result: OUT: found nfs_client, or new
709 * @cred: credential to use for trunking test
711 * Returns zero, a negative errno, or a negative NFS4ERR status.
712 * If zero is returned, an nfs_client pointer is planted in "result."
714 * NB: nfs41_walk_client_list() relies on the new nfs_client being
715 * the last nfs_client on the list.
717 int nfs41_walk_client_list(struct nfs_client *new,
718 struct nfs_client **result,
719 const struct cred *cred)
721 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
722 struct nfs_client *pos, *prev = NULL;
723 int status = -NFS4ERR_STALE_CLIENTID;
725 spin_lock(&nn->nfs_client_lock);
726 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
731 status = nfs4_match_client(pos, new, &prev, nn);
738 * Note that session trunking is just a special subcase of
739 * client id trunking. In either case, we want to fall back
740 * to using the existing nfs_client.
742 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
743 new->cl_serverowner))
747 refcount_inc(&pos->cl_count);
754 spin_unlock(&nn->nfs_client_lock);
755 nfs_put_client(prev);
758 #endif /* CONFIG_NFS_V4_1 */
760 static void nfs4_destroy_server(struct nfs_server *server)
764 nfs_server_return_all_delegations(server);
765 unset_pnfs_layoutdriver(server);
766 nfs4_purge_state_owners(server, &freeme);
767 nfs4_free_state_owners(&freeme);
771 * NFSv4.0 callback thread helper
773 * Find a client by callback identifier
776 nfs4_find_client_ident(struct net *net, int cb_ident)
778 struct nfs_client *clp;
779 struct nfs_net *nn = net_generic(net, nfs_net_id);
781 spin_lock(&nn->nfs_client_lock);
782 clp = idr_find(&nn->cb_ident_idr, cb_ident);
784 refcount_inc(&clp->cl_count);
785 spin_unlock(&nn->nfs_client_lock);
789 #if defined(CONFIG_NFS_V4_1)
790 /* Common match routine for v4.0 and v4.1 callback services */
791 static bool nfs4_cb_match_client(const struct sockaddr *addr,
792 struct nfs_client *clp, u32 minorversion)
794 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
796 /* Don't match clients that failed to initialise */
797 if (!(clp->cl_cons_state == NFS_CS_READY ||
798 clp->cl_cons_state == NFS_CS_SESSION_INITING))
803 /* Match the version and minorversion */
804 if (clp->rpc_ops->version != 4 ||
805 clp->cl_minorversion != minorversion)
808 /* Match only the IP address, not the port number */
809 return rpc_cmp_addr(addr, clap);
813 * NFSv4.1 callback thread helper
814 * For CB_COMPOUND calls, find a client by IP address, protocol version,
815 * minorversion, and sessionID
817 * Returns NULL if no such client
820 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
821 struct nfs4_sessionid *sid, u32 minorversion)
823 struct nfs_client *clp;
824 struct nfs_net *nn = net_generic(net, nfs_net_id);
826 spin_lock(&nn->nfs_client_lock);
827 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
828 if (!nfs4_cb_match_client(addr, clp, minorversion))
831 if (!nfs4_has_session(clp))
835 if (memcmp(clp->cl_session->sess_id.data,
836 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
839 refcount_inc(&clp->cl_count);
840 spin_unlock(&nn->nfs_client_lock);
843 spin_unlock(&nn->nfs_client_lock);
847 #else /* CONFIG_NFS_V4_1 */
850 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
851 struct nfs4_sessionid *sid, u32 minorversion)
855 #endif /* CONFIG_NFS_V4_1 */
858 * Set up an NFS4 client
860 static int nfs4_set_client(struct nfs_server *server,
861 const char *hostname,
862 const struct sockaddr *addr,
863 const size_t addrlen,
865 int proto, const struct rpc_timeout *timeparms,
866 u32 minorversion, unsigned int nconnect,
869 struct nfs_client_initdata cl_init = {
870 .hostname = hostname,
876 .minorversion = minorversion,
878 .timeparms = timeparms,
879 .cred = server->cred,
881 struct nfs_client *clp;
883 if (minorversion == 0)
884 __set_bit(NFS_CS_REUSEPORT, &cl_init.init_flags);
885 if (proto == XPRT_TRANSPORT_TCP)
886 cl_init.nconnect = nconnect;
888 if (server->flags & NFS_MOUNT_NORESVPORT)
889 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
890 if (server->options & NFS_OPTION_MIGRATION)
891 __set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
892 if (test_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status))
893 __set_bit(NFS_CS_TSM_POSSIBLE, &cl_init.init_flags);
894 server->port = rpc_get_port(addr);
896 /* Allocate or find a client reference we can use */
897 clp = nfs_get_client(&cl_init);
901 if (server->nfs_client == clp) {
907 * Query for the lease time on clientid setup or renewal
909 * Note that this will be set on nfs_clients that were created
910 * only for the DS role and did not set this bit, but now will
913 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
915 server->nfs_client = clp;
920 * Set up a pNFS Data Server client.
922 * Return any existing nfs_client that matches server address,port,version
925 * For a new nfs_client, use a soft mount (default), a low retrans and a
926 * low timeout interval so that if a connection is lost, we retry through
929 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
930 const struct sockaddr *ds_addr, int ds_addrlen,
931 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
934 struct rpc_timeout ds_timeout;
935 struct nfs_client *mds_clp = mds_srv->nfs_client;
936 struct nfs_client_initdata cl_init = {
938 .addrlen = ds_addrlen,
939 .nodename = mds_clp->cl_rpcclient->cl_nodename,
940 .ip_addr = mds_clp->cl_ipaddr,
943 .minorversion = minor_version,
944 .net = mds_clp->cl_net,
945 .timeparms = &ds_timeout,
946 .cred = mds_srv->cred,
948 char buf[INET6_ADDRSTRLEN + 1];
950 if (rpc_ntop(ds_addr, buf, sizeof(buf)) <= 0)
951 return ERR_PTR(-EINVAL);
952 cl_init.hostname = buf;
954 if (mds_clp->cl_nconnect > 1 && ds_proto == XPRT_TRANSPORT_TCP)
955 cl_init.nconnect = mds_clp->cl_nconnect;
957 if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
958 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
961 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
962 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
963 * (section 13.1 RFC 5661).
965 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
966 return nfs_get_client(&cl_init);
968 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
971 * Session has been established, and the client marked ready.
972 * Limit the mount rsize, wsize and dtsize using negotiated fore
973 * channel attributes.
975 static void nfs4_session_limit_rwsize(struct nfs_server *server)
977 #ifdef CONFIG_NFS_V4_1
978 struct nfs4_session *sess;
982 if (!nfs4_has_session(server->nfs_client))
984 sess = server->nfs_client->cl_session;
985 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
986 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
988 if (server->dtsize > server_resp_sz)
989 server->dtsize = server_resp_sz;
990 if (server->rsize > server_resp_sz)
991 server->rsize = server_resp_sz;
992 if (server->wsize > server_rqst_sz)
993 server->wsize = server_rqst_sz;
994 #endif /* CONFIG_NFS_V4_1 */
998 * Limit xattr sizes using the channel attributes.
1000 static void nfs4_session_limit_xasize(struct nfs_server *server)
1002 #ifdef CONFIG_NFS_V4_2
1003 struct nfs4_session *sess;
1008 if (!nfs4_has_session(server->nfs_client))
1011 sess = server->nfs_client->cl_session;
1013 server_gxa_sz = sess->fc_attrs.max_resp_sz - nfs42_maxgetxattr_overhead;
1014 server_sxa_sz = sess->fc_attrs.max_rqst_sz - nfs42_maxsetxattr_overhead;
1015 server_lxa_sz = sess->fc_attrs.max_resp_sz -
1016 nfs42_maxlistxattrs_overhead;
1018 if (server->gxasize > server_gxa_sz)
1019 server->gxasize = server_gxa_sz;
1020 if (server->sxasize > server_sxa_sz)
1021 server->sxasize = server_sxa_sz;
1022 if (server->lxasize > server_lxa_sz)
1023 server->lxasize = server_lxa_sz;
1027 static int nfs4_server_common_setup(struct nfs_server *server,
1028 struct nfs_fh *mntfh, bool auth_probe)
1030 struct nfs_fattr *fattr;
1033 /* data servers support only a subset of NFSv4.1 */
1034 if (is_ds_only_client(server->nfs_client))
1035 return -EPROTONOSUPPORT;
1037 fattr = nfs_alloc_fattr();
1041 /* We must ensure the session is initialised first */
1042 error = nfs4_init_session(server->nfs_client);
1046 /* Set the basic capabilities */
1047 server->caps |= server->nfs_client->cl_mvops->init_caps;
1048 if (server->flags & NFS_MOUNT_NORDIRPLUS)
1049 server->caps &= ~NFS_CAP_READDIRPLUS;
1050 if (server->nfs_client->cl_proto == XPRT_TRANSPORT_RDMA)
1051 server->caps &= ~NFS_CAP_READ_PLUS;
1053 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1056 if (nfs4_disable_idmapping &&
1057 server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1058 server->caps |= NFS_CAP_UIDGID_NOMAP;
1061 /* Probe the root fh to retrieve its FSID and filehandle */
1062 error = nfs4_get_rootfh(server, mntfh, auth_probe);
1066 dprintk("Server FSID: %llx:%llx\n",
1067 (unsigned long long) server->fsid.major,
1068 (unsigned long long) server->fsid.minor);
1069 nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1071 error = nfs_probe_fsinfo(server, mntfh, fattr);
1075 nfs4_session_limit_rwsize(server);
1076 nfs4_session_limit_xasize(server);
1078 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1079 server->namelen = NFS4_MAXNAMLEN;
1081 nfs_server_insert_lists(server);
1082 server->mount_time = jiffies;
1083 server->destroy = nfs4_destroy_server;
1085 nfs_free_fattr(fattr);
1090 * Create a version 4 volume record
1092 static int nfs4_init_server(struct nfs_server *server, struct fs_context *fc)
1094 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1095 struct rpc_timeout timeparms;
1098 nfs_init_timeout_values(&timeparms, ctx->nfs_server.protocol,
1099 ctx->timeo, ctx->retrans);
1101 /* Initialise the client representation from the mount data */
1102 server->flags = ctx->flags;
1103 server->options = ctx->options;
1104 server->auth_info = ctx->auth_info;
1106 /* Use the first specified auth flavor. If this flavor isn't
1107 * allowed by the server, use the SECINFO path to try the
1108 * other specified flavors */
1109 if (ctx->auth_info.flavor_len >= 1)
1110 ctx->selected_flavor = ctx->auth_info.flavors[0];
1112 ctx->selected_flavor = RPC_AUTH_UNIX;
1114 /* Get a client record */
1115 error = nfs4_set_client(server,
1116 ctx->nfs_server.hostname,
1117 &ctx->nfs_server.address,
1118 ctx->nfs_server.addrlen,
1119 ctx->client_address,
1120 ctx->nfs_server.protocol,
1123 ctx->nfs_server.nconnect,
1129 server->rsize = nfs_block_size(ctx->rsize, NULL);
1131 server->wsize = nfs_block_size(ctx->wsize, NULL);
1133 server->acregmin = ctx->acregmin * HZ;
1134 server->acregmax = ctx->acregmax * HZ;
1135 server->acdirmin = ctx->acdirmin * HZ;
1136 server->acdirmax = ctx->acdirmax * HZ;
1137 server->port = ctx->nfs_server.port;
1139 return nfs_init_server_rpcclient(server, &timeparms,
1140 ctx->selected_flavor);
1144 * Create a version 4 volume record
1145 * - keyed on server and FSID
1147 struct nfs_server *nfs4_create_server(struct fs_context *fc)
1149 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1150 struct nfs_server *server;
1154 server = nfs_alloc_server();
1156 return ERR_PTR(-ENOMEM);
1158 server->cred = get_cred(current_cred());
1160 auth_probe = ctx->auth_info.flavor_len < 1;
1162 /* set up the general RPC client */
1163 error = nfs4_init_server(server, fc);
1167 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1174 nfs_free_server(server);
1175 return ERR_PTR(error);
1179 * Create an NFS4 referral server record
1181 struct nfs_server *nfs4_create_referral_server(struct fs_context *fc)
1183 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1184 struct nfs_client *parent_client;
1185 struct nfs_server *server, *parent_server;
1189 server = nfs_alloc_server();
1191 return ERR_PTR(-ENOMEM);
1193 parent_server = NFS_SB(ctx->clone_data.sb);
1194 parent_client = parent_server->nfs_client;
1196 server->cred = get_cred(parent_server->cred);
1198 /* Initialise the client representation from the parent server */
1199 nfs_server_copy_userdata(server, parent_server);
1201 /* Get a client representation */
1202 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1203 rpc_set_port(&ctx->nfs_server.address, NFS_RDMA_PORT);
1204 error = nfs4_set_client(server,
1205 ctx->nfs_server.hostname,
1206 &ctx->nfs_server.address,
1207 ctx->nfs_server.addrlen,
1208 parent_client->cl_ipaddr,
1209 XPRT_TRANSPORT_RDMA,
1210 parent_server->client->cl_timeout,
1211 parent_client->cl_mvops->minor_version,
1212 parent_client->cl_nconnect,
1213 parent_client->cl_net);
1216 #endif /* IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA) */
1218 rpc_set_port(&ctx->nfs_server.address, NFS_PORT);
1219 error = nfs4_set_client(server,
1220 ctx->nfs_server.hostname,
1221 &ctx->nfs_server.address,
1222 ctx->nfs_server.addrlen,
1223 parent_client->cl_ipaddr,
1225 parent_server->client->cl_timeout,
1226 parent_client->cl_mvops->minor_version,
1227 parent_client->cl_nconnect,
1228 parent_client->cl_net);
1232 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1235 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout,
1236 ctx->selected_flavor);
1240 auth_probe = parent_server->auth_info.flavor_len < 1;
1242 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1249 nfs_free_server(server);
1250 return ERR_PTR(error);
1254 * Grab the destination's particulars, including lease expiry time.
1256 * Returns zero if probe succeeded and retrieved FSID matches the FSID
1259 static int nfs_probe_destination(struct nfs_server *server)
1261 struct inode *inode = d_inode(server->super->s_root);
1262 struct nfs_fattr *fattr;
1265 fattr = nfs_alloc_fattr();
1269 /* Sanity: the probe won't work if the destination server
1270 * does not recognize the migrated FH. */
1271 error = nfs_probe_fsinfo(server, NFS_FH(inode), fattr);
1273 nfs_free_fattr(fattr);
1278 * nfs4_update_server - Move an nfs_server to a different nfs_client
1280 * @server: represents FSID to be moved
1281 * @hostname: new end-point's hostname
1282 * @sap: new end-point's socket address
1283 * @salen: size of "sap"
1284 * @net: net namespace
1286 * The nfs_server must be quiescent before this function is invoked.
1287 * Either its session is drained (NFSv4.1+), or its transport is
1288 * plugged and drained (NFSv4.0).
1290 * Returns zero on success, or a negative errno value.
1292 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1293 struct sockaddr *sap, size_t salen, struct net *net)
1295 struct nfs_client *clp = server->nfs_client;
1296 struct rpc_clnt *clnt = server->client;
1297 struct xprt_create xargs = {
1298 .ident = clp->cl_proto,
1302 .servername = hostname,
1304 char buf[INET6_ADDRSTRLEN + 1];
1305 struct sockaddr_storage address;
1306 struct sockaddr *localaddr = (struct sockaddr *)&address;
1309 error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1313 error = rpc_localaddr(clnt, localaddr, sizeof(address));
1317 if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0)
1318 return -EAFNOSUPPORT;
1320 nfs_server_remove_lists(server);
1321 set_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1322 error = nfs4_set_client(server, hostname, sap, salen, buf,
1323 clp->cl_proto, clnt->cl_timeout,
1324 clp->cl_minorversion,
1325 clp->cl_nconnect, net);
1326 clear_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1328 nfs_server_insert_lists(server);
1331 nfs_put_client(clp);
1333 if (server->nfs_client->cl_hostname == NULL) {
1334 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1335 if (server->nfs_client->cl_hostname == NULL)
1338 nfs_server_insert_lists(server);
1340 return nfs_probe_destination(server);