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)
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);
405 static void nfs4_add_trunk(struct nfs_client *clp, struct nfs_client *old)
407 struct sockaddr_storage clp_addr, old_addr;
408 struct sockaddr *clp_sap = (struct sockaddr *)&clp_addr;
409 struct sockaddr *old_sap = (struct sockaddr *)&old_addr;
411 struct xprt_create xprt_args = {
412 .ident = old->cl_proto,
414 .servername = old->cl_hostname,
417 if (clp->cl_proto != old->cl_proto)
419 clp_salen = rpc_peeraddr(clp->cl_rpcclient, clp_sap, sizeof(clp_addr));
420 rpc_peeraddr(old->cl_rpcclient, old_sap, sizeof(old_addr));
422 if (clp_addr.ss_family != old_addr.ss_family)
425 xprt_args.dstaddr = clp_sap;
426 xprt_args.addrlen = clp_salen;
428 rpc_clnt_add_xprt(old->cl_rpcclient, &xprt_args,
429 rpc_clnt_test_and_add_xprt, NULL);
433 * nfs4_init_client - Initialise an NFS4 client record
435 * @clp: nfs_client to initialise
436 * @cl_init: pointer to nfs_client_initdata
438 * Returns pointer to an NFS client, or an ERR_PTR value.
440 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
441 const struct nfs_client_initdata *cl_init)
443 struct nfs_client *old;
446 if (clp->cl_cons_state == NFS_CS_READY)
447 /* the client is initialised already */
450 error = nfs4_init_client_minor_version(clp);
454 error = nfs4_discover_server_trunking(clp, &old);
459 clp->cl_preserve_clid = true;
461 * Mark the client as having failed initialization so other
462 * processes walking the nfs_client_list in nfs_match_client()
463 * won't try to use it.
465 nfs_mark_client_ready(clp, -EPERM);
466 if (old->cl_mvops->session_trunk)
467 nfs4_add_trunk(clp, old);
469 clear_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags);
474 nfs_mark_client_ready(clp, error);
476 return ERR_PTR(error);
480 * SETCLIENTID just did a callback update with the callback ident in
481 * "drop," but server trunking discovery claims "drop" and "keep" are
482 * actually the same server. Swap the callback IDs so that "keep"
483 * will continue to use the callback ident the server now knows about,
484 * and so that "keep"'s original callback ident is destroyed when
487 static void nfs4_swap_callback_idents(struct nfs_client *keep,
488 struct nfs_client *drop)
490 struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
491 unsigned int save = keep->cl_cb_ident;
493 if (keep->cl_cb_ident == drop->cl_cb_ident)
496 dprintk("%s: keeping callback ident %u and dropping ident %u\n",
497 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
499 spin_lock(&nn->nfs_client_lock);
501 idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
502 keep->cl_cb_ident = drop->cl_cb_ident;
504 idr_replace(&nn->cb_ident_idr, drop, save);
505 drop->cl_cb_ident = save;
507 spin_unlock(&nn->nfs_client_lock);
510 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
511 const struct nfs_client *clp2)
513 if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
515 return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
518 static bool nfs4_same_verifier(nfs4_verifier *v1, nfs4_verifier *v2)
520 return memcmp(v1->data, v2->data, sizeof(v1->data)) == 0;
523 static int nfs4_match_client(struct nfs_client *pos, struct nfs_client *new,
524 struct nfs_client **prev, struct nfs_net *nn)
528 if (pos->rpc_ops != new->rpc_ops)
531 if (pos->cl_minorversion != new->cl_minorversion)
534 /* If "pos" isn't marked ready, we can't trust the
535 * remaining fields in "pos", especially the client
536 * ID and serverowner fields. Wait for CREATE_SESSION
538 if (pos->cl_cons_state > NFS_CS_READY) {
539 refcount_inc(&pos->cl_count);
540 spin_unlock(&nn->nfs_client_lock);
542 nfs_put_client(*prev);
545 status = nfs_wait_client_init_complete(pos);
546 spin_lock(&nn->nfs_client_lock);
552 if (pos->cl_cons_state != NFS_CS_READY)
555 if (pos->cl_clientid != new->cl_clientid)
558 /* NFSv4.1 always uses the uniform string, however someone
559 * might switch the uniquifier string on us.
561 if (!nfs4_match_client_owner_id(pos, new))
568 * nfs40_walk_client_list - Find server that recognizes a client ID
570 * @new: nfs_client with client ID to test
571 * @result: OUT: found nfs_client, or new
572 * @cred: credential to use for trunking test
574 * Returns zero, a negative errno, or a negative NFS4ERR status.
575 * If zero is returned, an nfs_client pointer is planted in "result."
577 * NB: nfs40_walk_client_list() relies on the new nfs_client being
578 * the last nfs_client on the list.
580 int nfs40_walk_client_list(struct nfs_client *new,
581 struct nfs_client **result,
582 const struct cred *cred)
584 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
585 struct nfs_client *pos, *prev = NULL;
586 struct nfs4_setclientid_res clid = {
587 .clientid = new->cl_clientid,
588 .confirm = new->cl_confirm,
590 int status = -NFS4ERR_STALE_CLIENTID;
592 spin_lock(&nn->nfs_client_lock);
593 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
598 status = nfs4_match_client(pos, new, &prev, nn);
604 * We just sent a new SETCLIENTID, which should have
605 * caused the server to return a new cl_confirm. So if
606 * cl_confirm is the same, then this is a different
607 * server that just returned the same cl_confirm by
610 if ((new != pos) && nfs4_same_verifier(&pos->cl_confirm,
614 * But if the cl_confirm's are different, then the only
615 * way that a SETCLIENTID_CONFIRM to pos can succeed is
616 * if new and pos point to the same server:
619 refcount_inc(&pos->cl_count);
620 spin_unlock(&nn->nfs_client_lock);
622 nfs_put_client(prev);
625 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
627 case -NFS4ERR_STALE_CLIENTID:
630 nfs4_swap_callback_idents(pos, new);
631 pos->cl_confirm = new->cl_confirm;
632 nfs_mark_client_ready(pos, NFS_CS_READY);
639 /* The callback path may have been inadvertently
640 * changed. Schedule recovery!
642 nfs4_schedule_path_down_recovery(pos);
648 spin_lock(&nn->nfs_client_lock);
651 spin_unlock(&nn->nfs_client_lock);
653 /* No match found. The server lost our clientid */
655 nfs_put_client(prev);
659 #ifdef CONFIG_NFS_V4_1
661 * Returns true if the server major ids match
664 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
665 struct nfs41_server_owner *o2)
667 if (o1->major_id_sz != o2->major_id_sz)
669 return memcmp(o1->major_id, o2->major_id, o1->major_id_sz) == 0;
673 * Returns true if the server scopes match
676 nfs4_check_server_scope(struct nfs41_server_scope *s1,
677 struct nfs41_server_scope *s2)
679 if (s1->server_scope_sz != s2->server_scope_sz)
681 return memcmp(s1->server_scope, s2->server_scope,
682 s1->server_scope_sz) == 0;
686 * nfs4_detect_session_trunking - Checks for session trunking.
687 * @clp: original mount nfs_client
688 * @res: result structure from an exchange_id using the original mount
689 * nfs_client with a new multi_addr transport
690 * @xprt: pointer to the transport to add.
692 * Called after a successful EXCHANGE_ID on a multi-addr connection.
693 * Upon success, add the transport.
695 * Returns zero on success, otherwise -EINVAL
697 * Note: since the exchange_id for the new multi_addr transport uses the
698 * same nfs_client from the original mount, the cl_owner_id is reused,
699 * so eir_clientowner is the same.
701 int nfs4_detect_session_trunking(struct nfs_client *clp,
702 struct nfs41_exchange_id_res *res,
703 struct rpc_xprt *xprt)
705 /* Check eir_clientid */
706 if (clp->cl_clientid != res->clientid)
709 /* Check eir_server_owner so_major_id */
710 if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
714 /* Check eir_server_owner so_minor_id */
715 if (clp->cl_serverowner->minor_id != res->server_owner->minor_id)
718 /* Check eir_server_scope */
719 if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
722 pr_info("NFS: %s: Session trunking succeeded for %s\n",
724 xprt->address_strings[RPC_DISPLAY_ADDR]);
728 pr_info("NFS: %s: Session trunking failed for %s\n", clp->cl_hostname,
729 xprt->address_strings[RPC_DISPLAY_ADDR]);
735 * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
737 * @new: nfs_client with client ID to test
738 * @result: OUT: found nfs_client, or new
739 * @cred: credential to use for trunking test
741 * Returns zero, a negative errno, or a negative NFS4ERR status.
742 * If zero is returned, an nfs_client pointer is planted in "result."
744 * NB: nfs41_walk_client_list() relies on the new nfs_client being
745 * the last nfs_client on the list.
747 int nfs41_walk_client_list(struct nfs_client *new,
748 struct nfs_client **result,
749 const struct cred *cred)
751 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
752 struct nfs_client *pos, *prev = NULL;
753 int status = -NFS4ERR_STALE_CLIENTID;
755 spin_lock(&nn->nfs_client_lock);
756 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
761 status = nfs4_match_client(pos, new, &prev, nn);
768 * Note that session trunking is just a special subcase of
769 * client id trunking. In either case, we want to fall back
770 * to using the existing nfs_client.
772 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
773 new->cl_serverowner))
777 refcount_inc(&pos->cl_count);
784 spin_unlock(&nn->nfs_client_lock);
785 nfs_put_client(prev);
788 #endif /* CONFIG_NFS_V4_1 */
790 static void nfs4_destroy_server(struct nfs_server *server)
794 nfs_server_return_all_delegations(server);
795 unset_pnfs_layoutdriver(server);
796 nfs4_purge_state_owners(server, &freeme);
797 nfs4_free_state_owners(&freeme);
801 * NFSv4.0 callback thread helper
803 * Find a client by callback identifier
806 nfs4_find_client_ident(struct net *net, int cb_ident)
808 struct nfs_client *clp;
809 struct nfs_net *nn = net_generic(net, nfs_net_id);
811 spin_lock(&nn->nfs_client_lock);
812 clp = idr_find(&nn->cb_ident_idr, cb_ident);
814 refcount_inc(&clp->cl_count);
815 spin_unlock(&nn->nfs_client_lock);
819 #if defined(CONFIG_NFS_V4_1)
820 /* Common match routine for v4.0 and v4.1 callback services */
821 static bool nfs4_cb_match_client(const struct sockaddr *addr,
822 struct nfs_client *clp, u32 minorversion)
824 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
826 /* Don't match clients that failed to initialise */
827 if (!(clp->cl_cons_state == NFS_CS_READY ||
828 clp->cl_cons_state == NFS_CS_SESSION_INITING))
833 /* Match the version and minorversion */
834 if (clp->rpc_ops->version != 4 ||
835 clp->cl_minorversion != minorversion)
838 /* Match only the IP address, not the port number */
839 return rpc_cmp_addr(addr, clap);
843 * NFSv4.1 callback thread helper
844 * For CB_COMPOUND calls, find a client by IP address, protocol version,
845 * minorversion, and sessionID
847 * Returns NULL if no such client
850 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
851 struct nfs4_sessionid *sid, u32 minorversion)
853 struct nfs_client *clp;
854 struct nfs_net *nn = net_generic(net, nfs_net_id);
856 spin_lock(&nn->nfs_client_lock);
857 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
858 if (!nfs4_cb_match_client(addr, clp, minorversion))
861 if (!nfs4_has_session(clp))
865 if (memcmp(clp->cl_session->sess_id.data,
866 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
869 refcount_inc(&clp->cl_count);
870 spin_unlock(&nn->nfs_client_lock);
873 spin_unlock(&nn->nfs_client_lock);
877 #else /* CONFIG_NFS_V4_1 */
880 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
881 struct nfs4_sessionid *sid, u32 minorversion)
885 #endif /* CONFIG_NFS_V4_1 */
888 * Set up an NFS4 client
890 static int nfs4_set_client(struct nfs_server *server,
891 const char *hostname,
892 const struct sockaddr *addr,
893 const size_t addrlen,
895 int proto, const struct rpc_timeout *timeparms,
896 u32 minorversion, unsigned int nconnect,
897 unsigned int max_connect,
900 struct nfs_client_initdata cl_init = {
901 .hostname = hostname,
907 .minorversion = minorversion,
909 .timeparms = timeparms,
910 .cred = server->cred,
912 struct nfs_client *clp;
914 if (minorversion == 0)
915 __set_bit(NFS_CS_REUSEPORT, &cl_init.init_flags);
917 cl_init.max_connect = max_connect;
918 if (proto == XPRT_TRANSPORT_TCP)
919 cl_init.nconnect = nconnect;
921 if (server->flags & NFS_MOUNT_NORESVPORT)
922 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
923 if (server->options & NFS_OPTION_MIGRATION)
924 __set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
925 if (test_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status))
926 __set_bit(NFS_CS_TSM_POSSIBLE, &cl_init.init_flags);
927 server->port = rpc_get_port(addr);
929 /* Allocate or find a client reference we can use */
930 clp = nfs_get_client(&cl_init);
934 if (server->nfs_client == clp) {
940 * Query for the lease time on clientid setup or renewal
942 * Note that this will be set on nfs_clients that were created
943 * only for the DS role and did not set this bit, but now will
946 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
948 server->nfs_client = clp;
953 * Set up a pNFS Data Server client.
955 * Return any existing nfs_client that matches server address,port,version
958 * For a new nfs_client, use a soft mount (default), a low retrans and a
959 * low timeout interval so that if a connection is lost, we retry through
962 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
963 const struct sockaddr *ds_addr, int ds_addrlen,
964 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
967 struct rpc_timeout ds_timeout;
968 struct nfs_client *mds_clp = mds_srv->nfs_client;
969 struct nfs_client_initdata cl_init = {
971 .addrlen = ds_addrlen,
972 .nodename = mds_clp->cl_rpcclient->cl_nodename,
973 .ip_addr = mds_clp->cl_ipaddr,
976 .minorversion = minor_version,
977 .net = mds_clp->cl_net,
978 .timeparms = &ds_timeout,
979 .cred = mds_srv->cred,
981 char buf[INET6_ADDRSTRLEN + 1];
983 if (rpc_ntop(ds_addr, buf, sizeof(buf)) <= 0)
984 return ERR_PTR(-EINVAL);
985 cl_init.hostname = buf;
987 if (mds_clp->cl_nconnect > 1 && ds_proto == XPRT_TRANSPORT_TCP) {
988 cl_init.nconnect = mds_clp->cl_nconnect;
989 cl_init.max_connect = NFS_MAX_TRANSPORTS;
992 if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
993 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
996 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
997 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
998 * (section 13.1 RFC 5661).
1000 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
1001 return nfs_get_client(&cl_init);
1003 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
1006 * Session has been established, and the client marked ready.
1007 * Limit the mount rsize, wsize and dtsize using negotiated fore
1008 * channel attributes.
1010 static void nfs4_session_limit_rwsize(struct nfs_server *server)
1012 #ifdef CONFIG_NFS_V4_1
1013 struct nfs4_session *sess;
1017 if (!nfs4_has_session(server->nfs_client))
1019 sess = server->nfs_client->cl_session;
1020 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1021 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1023 if (server->dtsize > server_resp_sz)
1024 server->dtsize = server_resp_sz;
1025 if (server->rsize > server_resp_sz)
1026 server->rsize = server_resp_sz;
1027 if (server->wsize > server_rqst_sz)
1028 server->wsize = server_rqst_sz;
1029 #endif /* CONFIG_NFS_V4_1 */
1033 * Limit xattr sizes using the channel attributes.
1035 static void nfs4_session_limit_xasize(struct nfs_server *server)
1037 #ifdef CONFIG_NFS_V4_2
1038 struct nfs4_session *sess;
1043 if (!nfs4_has_session(server->nfs_client))
1046 sess = server->nfs_client->cl_session;
1048 server_gxa_sz = sess->fc_attrs.max_resp_sz - nfs42_maxgetxattr_overhead;
1049 server_sxa_sz = sess->fc_attrs.max_rqst_sz - nfs42_maxsetxattr_overhead;
1050 server_lxa_sz = sess->fc_attrs.max_resp_sz -
1051 nfs42_maxlistxattrs_overhead;
1053 if (server->gxasize > server_gxa_sz)
1054 server->gxasize = server_gxa_sz;
1055 if (server->sxasize > server_sxa_sz)
1056 server->sxasize = server_sxa_sz;
1057 if (server->lxasize > server_lxa_sz)
1058 server->lxasize = server_lxa_sz;
1062 void nfs4_server_set_init_caps(struct nfs_server *server)
1064 /* Set the basic capabilities */
1065 server->caps |= server->nfs_client->cl_mvops->init_caps;
1066 if (server->flags & NFS_MOUNT_NORDIRPLUS)
1067 server->caps &= ~NFS_CAP_READDIRPLUS;
1068 if (server->nfs_client->cl_proto == XPRT_TRANSPORT_RDMA)
1069 server->caps &= ~NFS_CAP_READ_PLUS;
1072 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1075 if (nfs4_disable_idmapping &&
1076 server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1077 server->caps |= NFS_CAP_UIDGID_NOMAP;
1080 static int nfs4_server_common_setup(struct nfs_server *server,
1081 struct nfs_fh *mntfh, bool auth_probe)
1085 /* data servers support only a subset of NFSv4.1 */
1086 if (is_ds_only_client(server->nfs_client))
1087 return -EPROTONOSUPPORT;
1089 /* We must ensure the session is initialised first */
1090 error = nfs4_init_session(server->nfs_client);
1094 nfs4_server_set_init_caps(server);
1096 /* Probe the root fh to retrieve its FSID and filehandle */
1097 error = nfs4_get_rootfh(server, mntfh, auth_probe);
1101 dprintk("Server FSID: %llx:%llx\n",
1102 (unsigned long long) server->fsid.major,
1103 (unsigned long long) server->fsid.minor);
1104 nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1106 error = nfs_probe_server(server, mntfh);
1110 nfs4_session_limit_rwsize(server);
1111 nfs4_session_limit_xasize(server);
1113 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1114 server->namelen = NFS4_MAXNAMLEN;
1116 nfs_server_insert_lists(server);
1117 server->mount_time = jiffies;
1118 server->destroy = nfs4_destroy_server;
1124 * Create a version 4 volume record
1126 static int nfs4_init_server(struct nfs_server *server, struct fs_context *fc)
1128 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1129 struct rpc_timeout timeparms;
1132 nfs_init_timeout_values(&timeparms, ctx->nfs_server.protocol,
1133 ctx->timeo, ctx->retrans);
1135 /* Initialise the client representation from the mount data */
1136 server->flags = ctx->flags;
1137 server->options = ctx->options;
1138 server->auth_info = ctx->auth_info;
1140 /* Use the first specified auth flavor. If this flavor isn't
1141 * allowed by the server, use the SECINFO path to try the
1142 * other specified flavors */
1143 if (ctx->auth_info.flavor_len >= 1)
1144 ctx->selected_flavor = ctx->auth_info.flavors[0];
1146 ctx->selected_flavor = RPC_AUTH_UNIX;
1148 /* Get a client record */
1149 error = nfs4_set_client(server,
1150 ctx->nfs_server.hostname,
1151 &ctx->nfs_server.address,
1152 ctx->nfs_server.addrlen,
1153 ctx->client_address,
1154 ctx->nfs_server.protocol,
1157 ctx->nfs_server.nconnect,
1158 ctx->nfs_server.max_connect,
1164 server->rsize = nfs_block_size(ctx->rsize, NULL);
1166 server->wsize = nfs_block_size(ctx->wsize, NULL);
1168 server->acregmin = ctx->acregmin * HZ;
1169 server->acregmax = ctx->acregmax * HZ;
1170 server->acdirmin = ctx->acdirmin * HZ;
1171 server->acdirmax = ctx->acdirmax * HZ;
1172 server->port = ctx->nfs_server.port;
1174 return nfs_init_server_rpcclient(server, &timeparms,
1175 ctx->selected_flavor);
1179 * Create a version 4 volume record
1180 * - keyed on server and FSID
1182 struct nfs_server *nfs4_create_server(struct fs_context *fc)
1184 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1185 struct nfs_server *server;
1189 server = nfs_alloc_server();
1191 return ERR_PTR(-ENOMEM);
1193 server->cred = get_cred(fc->cred);
1195 auth_probe = ctx->auth_info.flavor_len < 1;
1197 /* set up the general RPC client */
1198 error = nfs4_init_server(server, fc);
1202 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1209 nfs_free_server(server);
1210 return ERR_PTR(error);
1214 * Create an NFS4 referral server record
1216 struct nfs_server *nfs4_create_referral_server(struct fs_context *fc)
1218 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1219 struct nfs_client *parent_client;
1220 struct nfs_server *server, *parent_server;
1224 server = nfs_alloc_server();
1226 return ERR_PTR(-ENOMEM);
1228 parent_server = NFS_SB(ctx->clone_data.sb);
1229 parent_client = parent_server->nfs_client;
1231 server->cred = get_cred(parent_server->cred);
1233 /* Initialise the client representation from the parent server */
1234 nfs_server_copy_userdata(server, parent_server);
1236 /* Get a client representation */
1237 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1238 rpc_set_port(&ctx->nfs_server.address, NFS_RDMA_PORT);
1239 error = nfs4_set_client(server,
1240 ctx->nfs_server.hostname,
1241 &ctx->nfs_server.address,
1242 ctx->nfs_server.addrlen,
1243 parent_client->cl_ipaddr,
1244 XPRT_TRANSPORT_RDMA,
1245 parent_server->client->cl_timeout,
1246 parent_client->cl_mvops->minor_version,
1247 parent_client->cl_nconnect,
1248 parent_client->cl_max_connect,
1249 parent_client->cl_net);
1252 #endif /* IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA) */
1254 rpc_set_port(&ctx->nfs_server.address, NFS_PORT);
1255 error = nfs4_set_client(server,
1256 ctx->nfs_server.hostname,
1257 &ctx->nfs_server.address,
1258 ctx->nfs_server.addrlen,
1259 parent_client->cl_ipaddr,
1261 parent_server->client->cl_timeout,
1262 parent_client->cl_mvops->minor_version,
1263 parent_client->cl_nconnect,
1264 parent_client->cl_max_connect,
1265 parent_client->cl_net);
1269 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1272 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout,
1273 ctx->selected_flavor);
1277 auth_probe = parent_server->auth_info.flavor_len < 1;
1279 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1286 nfs_free_server(server);
1287 return ERR_PTR(error);
1291 * nfs4_update_server - Move an nfs_server to a different nfs_client
1293 * @server: represents FSID to be moved
1294 * @hostname: new end-point's hostname
1295 * @sap: new end-point's socket address
1296 * @salen: size of "sap"
1297 * @net: net namespace
1299 * The nfs_server must be quiescent before this function is invoked.
1300 * Either its session is drained (NFSv4.1+), or its transport is
1301 * plugged and drained (NFSv4.0).
1303 * Returns zero on success, or a negative errno value.
1305 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1306 struct sockaddr *sap, size_t salen, struct net *net)
1308 struct nfs_client *clp = server->nfs_client;
1309 struct rpc_clnt *clnt = server->client;
1310 struct xprt_create xargs = {
1311 .ident = clp->cl_proto,
1315 .servername = hostname,
1317 char buf[INET6_ADDRSTRLEN + 1];
1318 struct sockaddr_storage address;
1319 struct sockaddr *localaddr = (struct sockaddr *)&address;
1322 error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1326 error = rpc_localaddr(clnt, localaddr, sizeof(address));
1330 if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0)
1331 return -EAFNOSUPPORT;
1333 nfs_server_remove_lists(server);
1334 set_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1335 error = nfs4_set_client(server, hostname, sap, salen, buf,
1336 clp->cl_proto, clnt->cl_timeout,
1337 clp->cl_minorversion,
1338 clp->cl_nconnect, clp->cl_max_connect, net);
1339 clear_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1341 nfs_server_insert_lists(server);
1344 nfs_put_client(clp);
1346 if (server->nfs_client->cl_hostname == NULL)
1347 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1348 nfs_server_insert_lists(server);
1350 return nfs_probe_server(server, NFS_FH(d_inode(server->super->s_root)));