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"
23 #define NFSDBG_FACILITY NFSDBG_CLIENT
26 * Get a unique NFSv4.0 callback identifier which will be used
27 * by the V4.0 callback service to lookup the nfs_client struct
29 static int nfs_get_cb_ident_idr(struct nfs_client *clp, int minorversion)
32 struct nfs_net *nn = net_generic(clp->cl_net, nfs_net_id);
34 if (clp->rpc_ops->version != 4 || minorversion != 0)
36 idr_preload(GFP_KERNEL);
37 spin_lock(&nn->nfs_client_lock);
38 ret = idr_alloc(&nn->cb_ident_idr, clp, 1, 0, GFP_NOWAIT);
40 clp->cl_cb_ident = ret;
41 spin_unlock(&nn->nfs_client_lock);
43 return ret < 0 ? ret : 0;
46 #ifdef CONFIG_NFS_V4_1
48 * Per auth flavor data server rpc clients
50 struct nfs4_ds_server {
51 struct list_head list; /* ds_clp->cl_ds_clients */
52 struct rpc_clnt *rpc_clnt;
56 * nfs4_find_ds_client - Common lookup case for DS I/O
57 * @ds_clp: pointer to the DS's nfs_client
58 * @flavor: rpc auth flavour to match
60 static struct nfs4_ds_server *
61 nfs4_find_ds_client(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
63 struct nfs4_ds_server *dss;
66 list_for_each_entry_rcu(dss, &ds_clp->cl_ds_clients, list) {
67 if (dss->rpc_clnt->cl_auth->au_flavor != flavor)
77 static struct nfs4_ds_server *
78 nfs4_add_ds_client(struct nfs_client *ds_clp, rpc_authflavor_t flavor,
79 struct nfs4_ds_server *new)
81 struct nfs4_ds_server *dss;
83 spin_lock(&ds_clp->cl_lock);
84 list_for_each_entry(dss, &ds_clp->cl_ds_clients, list) {
85 if (dss->rpc_clnt->cl_auth->au_flavor != flavor)
90 list_add_rcu(&new->list, &ds_clp->cl_ds_clients);
93 spin_unlock(&ds_clp->cl_lock); /* need some lock to protect list */
97 static struct nfs4_ds_server *
98 nfs4_alloc_ds_server(struct nfs_client *ds_clp, rpc_authflavor_t flavor)
100 struct nfs4_ds_server *dss;
102 dss = kmalloc(sizeof(*dss), GFP_NOFS);
104 return ERR_PTR(-ENOMEM);
106 dss->rpc_clnt = rpc_clone_client_set_auth(ds_clp->cl_rpcclient, flavor);
107 if (IS_ERR(dss->rpc_clnt)) {
108 int err = PTR_ERR(dss->rpc_clnt);
112 INIT_LIST_HEAD(&dss->list);
118 nfs4_free_ds_server(struct nfs4_ds_server *dss)
120 rpc_release_client(dss->rpc_clnt);
125 * nfs4_find_or_create_ds_client - Find or create a DS rpc client
126 * @ds_clp: pointer to the DS's nfs_client
127 * @inode: pointer to the inode
129 * Find or create a DS rpc client with th MDS server rpc client auth flavor
130 * in the nfs_client cl_ds_clients list.
133 nfs4_find_or_create_ds_client(struct nfs_client *ds_clp, struct inode *inode)
135 struct nfs4_ds_server *dss, *new;
136 rpc_authflavor_t flavor = NFS_SERVER(inode)->client->cl_auth->au_flavor;
138 dss = nfs4_find_ds_client(ds_clp, flavor);
141 new = nfs4_alloc_ds_server(ds_clp, flavor);
143 return ERR_CAST(new);
144 dss = nfs4_add_ds_client(ds_clp, flavor, new);
146 nfs4_free_ds_server(new);
148 return dss->rpc_clnt;
150 EXPORT_SYMBOL_GPL(nfs4_find_or_create_ds_client);
153 nfs4_shutdown_ds_clients(struct nfs_client *clp)
155 struct nfs4_ds_server *dss;
157 while (!list_empty(&clp->cl_ds_clients)) {
158 dss = list_entry(clp->cl_ds_clients.next,
159 struct nfs4_ds_server, list);
160 list_del(&dss->list);
161 rpc_shutdown_client(dss->rpc_clnt);
167 nfs4_cleanup_callback(struct nfs_client *clp)
169 struct nfs4_copy_state *cp_state;
171 while (!list_empty(&clp->pending_cb_stateids)) {
172 cp_state = list_entry(clp->pending_cb_stateids.next,
173 struct nfs4_copy_state, copies);
174 list_del(&cp_state->copies);
179 void nfs41_shutdown_client(struct nfs_client *clp)
181 if (nfs4_has_session(clp)) {
182 nfs4_cleanup_callback(clp);
183 nfs4_shutdown_ds_clients(clp);
184 nfs4_destroy_session(clp->cl_session);
185 nfs4_destroy_clientid(clp);
189 #endif /* CONFIG_NFS_V4_1 */
191 void nfs40_shutdown_client(struct nfs_client *clp)
193 if (clp->cl_slot_tbl) {
194 nfs4_shutdown_slot_table(clp->cl_slot_tbl);
195 kfree(clp->cl_slot_tbl);
199 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *cl_init)
201 char buf[INET6_ADDRSTRLEN + 1];
202 const char *ip_addr = cl_init->ip_addr;
203 struct nfs_client *clp = nfs_alloc_client(cl_init);
209 err = nfs_get_cb_ident_idr(clp, cl_init->minorversion);
213 if (cl_init->minorversion > NFS4_MAX_MINOR_VERSION) {
218 spin_lock_init(&clp->cl_lock);
219 INIT_DELAYED_WORK(&clp->cl_renewd, nfs4_renew_state);
220 INIT_LIST_HEAD(&clp->cl_ds_clients);
221 rpc_init_wait_queue(&clp->cl_rpcwaitq, "NFS client");
222 clp->cl_state = 1 << NFS4CLNT_LEASE_EXPIRED;
223 clp->cl_mvops = nfs_v4_minor_ops[cl_init->minorversion];
225 #if IS_ENABLED(CONFIG_NFS_V4_1)
226 init_waitqueue_head(&clp->cl_lock_waitq);
228 INIT_LIST_HEAD(&clp->pending_cb_stateids);
230 if (cl_init->minorversion != 0)
231 __set_bit(NFS_CS_INFINITE_SLOTS, &clp->cl_flags);
232 __set_bit(NFS_CS_DISCRTRY, &clp->cl_flags);
233 __set_bit(NFS_CS_NO_RETRANS_TIMEOUT, &clp->cl_flags);
235 if (test_bit(NFS_CS_DS, &cl_init->init_flags))
236 __set_bit(NFS_CS_DS, &clp->cl_flags);
238 * Set up the connection to the server before we add add to the
241 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_GSS_KRB5I);
243 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
247 /* If no clientaddr= option was specified, find a usable cb address */
248 if (ip_addr == NULL) {
249 struct sockaddr_storage cb_addr;
250 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
252 err = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
255 err = rpc_ntop(sap, buf, sizeof(buf));
258 ip_addr = (const char *)buf;
260 strscpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
262 err = nfs_idmap_new(clp);
264 dprintk("%s: failed to create idmapper. Error = %d\n",
268 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
272 nfs_free_client(clp);
277 * Destroy the NFS4 callback service
279 static void nfs4_destroy_callback(struct nfs_client *clp)
281 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
282 nfs_callback_down(clp->cl_mvops->minor_version, clp->cl_net);
285 static void nfs4_shutdown_client(struct nfs_client *clp)
287 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
288 nfs4_kill_renewd(clp);
289 clp->cl_mvops->shutdown_client(clp);
290 nfs4_destroy_callback(clp);
291 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
292 nfs_idmap_delete(clp);
294 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
295 kfree(clp->cl_serverowner);
296 kfree(clp->cl_serverscope);
297 kfree(clp->cl_implid);
298 kfree(clp->cl_owner_id);
301 void nfs4_free_client(struct nfs_client *clp)
303 nfs4_shutdown_client(clp);
304 nfs_free_client(clp);
308 * Initialize the NFS4 callback service
310 static int nfs4_init_callback(struct nfs_client *clp)
312 struct rpc_xprt *xprt;
315 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
317 if (nfs4_has_session(clp)) {
318 error = xprt_setup_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
323 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
325 dprintk("%s: failed to start callback. Error = %d\n",
329 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
335 * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
336 * @clp: nfs_client to initialize
338 * Returns zero on success, or a negative errno if some error occurred.
340 int nfs40_init_client(struct nfs_client *clp)
342 struct nfs4_slot_table *tbl;
345 tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
349 ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
350 "NFSv4.0 transport Slot table");
352 nfs4_shutdown_slot_table(tbl);
357 clp->cl_slot_tbl = tbl;
361 #if defined(CONFIG_NFS_V4_1)
364 * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
365 * @clp: nfs_client to initialize
367 * Returns zero on success, or a negative errno if some error occurred.
369 int nfs41_init_client(struct nfs_client *clp)
371 struct nfs4_session *session = NULL;
374 * Create the session and mark it expired.
375 * When a SEQUENCE operation encounters the expired session
376 * it will do session recovery to initialize it.
378 session = nfs4_alloc_session(clp);
382 clp->cl_session = session;
385 * The create session reply races with the server back
386 * channel probe. Mark the client NFS_CS_SESSION_INITING
387 * so that the client back channel can find the
390 nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
394 #endif /* CONFIG_NFS_V4_1 */
397 * Initialize the minor version specific parts of an NFS4 client record
399 static int nfs4_init_client_minor_version(struct nfs_client *clp)
403 ret = clp->cl_mvops->init_client(clp);
406 return nfs4_init_callback(clp);
409 static void nfs4_add_trunk(struct nfs_client *clp, struct nfs_client *old)
411 struct sockaddr_storage clp_addr, old_addr;
412 struct sockaddr *clp_sap = (struct sockaddr *)&clp_addr;
413 struct sockaddr *old_sap = (struct sockaddr *)&old_addr;
415 struct xprt_create xprt_args = {
416 .ident = old->cl_proto,
418 .servername = old->cl_hostname,
421 if (clp->cl_proto != old->cl_proto)
423 clp_salen = rpc_peeraddr(clp->cl_rpcclient, clp_sap, sizeof(clp_addr));
424 rpc_peeraddr(old->cl_rpcclient, old_sap, sizeof(old_addr));
426 if (clp_addr.ss_family != old_addr.ss_family)
429 xprt_args.dstaddr = clp_sap;
430 xprt_args.addrlen = clp_salen;
432 rpc_clnt_add_xprt(old->cl_rpcclient, &xprt_args,
433 rpc_clnt_test_and_add_xprt, NULL);
437 * nfs4_init_client - Initialise an NFS4 client record
439 * @clp: nfs_client to initialise
440 * @cl_init: pointer to nfs_client_initdata
442 * Returns pointer to an NFS client, or an ERR_PTR value.
444 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
445 const struct nfs_client_initdata *cl_init)
447 struct nfs_client *old;
450 if (clp->cl_cons_state == NFS_CS_READY)
451 /* the client is initialised already */
454 error = nfs4_init_client_minor_version(clp);
458 error = nfs4_discover_server_trunking(clp, &old);
463 clp->cl_preserve_clid = true;
465 * Mark the client as having failed initialization so other
466 * processes walking the nfs_client_list in nfs_match_client()
467 * won't try to use it.
469 nfs_mark_client_ready(clp, -EPERM);
470 if (old->cl_mvops->session_trunk)
471 nfs4_add_trunk(clp, old);
473 clear_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags);
478 nfs_mark_client_ready(clp, error);
480 return ERR_PTR(error);
484 * SETCLIENTID just did a callback update with the callback ident in
485 * "drop," but server trunking discovery claims "drop" and "keep" are
486 * actually the same server. Swap the callback IDs so that "keep"
487 * will continue to use the callback ident the server now knows about,
488 * and so that "keep"'s original callback ident is destroyed when
491 static void nfs4_swap_callback_idents(struct nfs_client *keep,
492 struct nfs_client *drop)
494 struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
495 unsigned int save = keep->cl_cb_ident;
497 if (keep->cl_cb_ident == drop->cl_cb_ident)
500 dprintk("%s: keeping callback ident %u and dropping ident %u\n",
501 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
503 spin_lock(&nn->nfs_client_lock);
505 idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
506 keep->cl_cb_ident = drop->cl_cb_ident;
508 idr_replace(&nn->cb_ident_idr, drop, save);
509 drop->cl_cb_ident = save;
511 spin_unlock(&nn->nfs_client_lock);
514 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
515 const struct nfs_client *clp2)
517 if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
519 return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
522 static bool nfs4_same_verifier(nfs4_verifier *v1, nfs4_verifier *v2)
524 return memcmp(v1->data, v2->data, sizeof(v1->data)) == 0;
527 static int nfs4_match_client(struct nfs_client *pos, struct nfs_client *new,
528 struct nfs_client **prev, struct nfs_net *nn)
532 if (pos->rpc_ops != new->rpc_ops)
535 if (pos->cl_minorversion != new->cl_minorversion)
538 /* If "pos" isn't marked ready, we can't trust the
539 * remaining fields in "pos", especially the client
540 * ID and serverowner fields. Wait for CREATE_SESSION
542 if (pos->cl_cons_state > NFS_CS_READY) {
543 refcount_inc(&pos->cl_count);
544 spin_unlock(&nn->nfs_client_lock);
546 nfs_put_client(*prev);
549 status = nfs_wait_client_init_complete(pos);
550 spin_lock(&nn->nfs_client_lock);
556 if (pos->cl_cons_state != NFS_CS_READY)
559 if (pos->cl_clientid != new->cl_clientid)
562 /* NFSv4.1 always uses the uniform string, however someone
563 * might switch the uniquifier string on us.
565 if (!nfs4_match_client_owner_id(pos, new))
572 * nfs40_walk_client_list - Find server that recognizes a client ID
574 * @new: nfs_client with client ID to test
575 * @result: OUT: found nfs_client, or new
576 * @cred: credential to use for trunking test
578 * Returns zero, a negative errno, or a negative NFS4ERR status.
579 * If zero is returned, an nfs_client pointer is planted in "result."
581 * NB: nfs40_walk_client_list() relies on the new nfs_client being
582 * the last nfs_client on the list.
584 int nfs40_walk_client_list(struct nfs_client *new,
585 struct nfs_client **result,
586 const struct cred *cred)
588 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
589 struct nfs_client *pos, *prev = NULL;
590 struct nfs4_setclientid_res clid = {
591 .clientid = new->cl_clientid,
592 .confirm = new->cl_confirm,
594 int status = -NFS4ERR_STALE_CLIENTID;
596 spin_lock(&nn->nfs_client_lock);
597 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
602 status = nfs4_match_client(pos, new, &prev, nn);
608 * We just sent a new SETCLIENTID, which should have
609 * caused the server to return a new cl_confirm. So if
610 * cl_confirm is the same, then this is a different
611 * server that just returned the same cl_confirm by
614 if ((new != pos) && nfs4_same_verifier(&pos->cl_confirm,
618 * But if the cl_confirm's are different, then the only
619 * way that a SETCLIENTID_CONFIRM to pos can succeed is
620 * if new and pos point to the same server:
623 refcount_inc(&pos->cl_count);
624 spin_unlock(&nn->nfs_client_lock);
626 nfs_put_client(prev);
629 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
631 case -NFS4ERR_STALE_CLIENTID:
634 nfs4_swap_callback_idents(pos, new);
635 pos->cl_confirm = new->cl_confirm;
636 nfs_mark_client_ready(pos, NFS_CS_READY);
643 /* The callback path may have been inadvertently
644 * changed. Schedule recovery!
646 nfs4_schedule_path_down_recovery(pos);
652 spin_lock(&nn->nfs_client_lock);
655 spin_unlock(&nn->nfs_client_lock);
657 /* No match found. The server lost our clientid */
659 nfs_put_client(prev);
663 #ifdef CONFIG_NFS_V4_1
665 * Returns true if the server major ids match
668 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
669 struct nfs41_server_owner *o2)
671 if (o1->major_id_sz != o2->major_id_sz)
673 return memcmp(o1->major_id, o2->major_id, o1->major_id_sz) == 0;
677 * Returns true if the server scopes match
680 nfs4_check_server_scope(struct nfs41_server_scope *s1,
681 struct nfs41_server_scope *s2)
683 if (s1->server_scope_sz != s2->server_scope_sz)
685 return memcmp(s1->server_scope, s2->server_scope,
686 s1->server_scope_sz) == 0;
690 * nfs4_detect_session_trunking - Checks for session trunking.
691 * @clp: original mount nfs_client
692 * @res: result structure from an exchange_id using the original mount
693 * nfs_client with a new multi_addr transport
694 * @xprt: pointer to the transport to add.
696 * Called after a successful EXCHANGE_ID on a multi-addr connection.
697 * Upon success, add the transport.
699 * Returns zero on success, otherwise -EINVAL
701 * Note: since the exchange_id for the new multi_addr transport uses the
702 * same nfs_client from the original mount, the cl_owner_id is reused,
703 * so eir_clientowner is the same.
705 int nfs4_detect_session_trunking(struct nfs_client *clp,
706 struct nfs41_exchange_id_res *res,
707 struct rpc_xprt *xprt)
709 /* Check eir_clientid */
710 if (clp->cl_clientid != res->clientid)
713 /* Check eir_server_owner so_major_id */
714 if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
718 /* Check eir_server_owner so_minor_id */
719 if (clp->cl_serverowner->minor_id != res->server_owner->minor_id)
722 /* Check eir_server_scope */
723 if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
726 pr_info("NFS: %s: Session trunking succeeded for %s\n",
728 xprt->address_strings[RPC_DISPLAY_ADDR]);
732 pr_info("NFS: %s: Session trunking failed for %s\n", clp->cl_hostname,
733 xprt->address_strings[RPC_DISPLAY_ADDR]);
739 * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
741 * @new: nfs_client with client ID to test
742 * @result: OUT: found nfs_client, or new
743 * @cred: credential to use for trunking test
745 * Returns zero, a negative errno, or a negative NFS4ERR status.
746 * If zero is returned, an nfs_client pointer is planted in "result."
748 * NB: nfs41_walk_client_list() relies on the new nfs_client being
749 * the last nfs_client on the list.
751 int nfs41_walk_client_list(struct nfs_client *new,
752 struct nfs_client **result,
753 const struct cred *cred)
755 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
756 struct nfs_client *pos, *prev = NULL;
757 int status = -NFS4ERR_STALE_CLIENTID;
759 spin_lock(&nn->nfs_client_lock);
760 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
765 status = nfs4_match_client(pos, new, &prev, nn);
772 * Note that session trunking is just a special subcase of
773 * client id trunking. In either case, we want to fall back
774 * to using the existing nfs_client.
776 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
777 new->cl_serverowner))
781 refcount_inc(&pos->cl_count);
788 spin_unlock(&nn->nfs_client_lock);
789 nfs_put_client(prev);
792 #endif /* CONFIG_NFS_V4_1 */
794 static void nfs4_destroy_server(struct nfs_server *server)
798 nfs_server_return_all_delegations(server);
799 unset_pnfs_layoutdriver(server);
800 nfs4_purge_state_owners(server, &freeme);
801 nfs4_free_state_owners(&freeme);
805 * NFSv4.0 callback thread helper
807 * Find a client by callback identifier
810 nfs4_find_client_ident(struct net *net, int cb_ident)
812 struct nfs_client *clp;
813 struct nfs_net *nn = net_generic(net, nfs_net_id);
815 spin_lock(&nn->nfs_client_lock);
816 clp = idr_find(&nn->cb_ident_idr, cb_ident);
818 refcount_inc(&clp->cl_count);
819 spin_unlock(&nn->nfs_client_lock);
823 #if defined(CONFIG_NFS_V4_1)
824 /* Common match routine for v4.0 and v4.1 callback services */
825 static bool nfs4_cb_match_client(const struct sockaddr *addr,
826 struct nfs_client *clp, u32 minorversion)
828 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
830 /* Don't match clients that failed to initialise */
831 if (!(clp->cl_cons_state == NFS_CS_READY ||
832 clp->cl_cons_state == NFS_CS_SESSION_INITING))
837 /* Match the version and minorversion */
838 if (clp->rpc_ops->version != 4 ||
839 clp->cl_minorversion != minorversion)
842 /* Match only the IP address, not the port number */
843 return rpc_cmp_addr(addr, clap);
847 * NFSv4.1 callback thread helper
848 * For CB_COMPOUND calls, find a client by IP address, protocol version,
849 * minorversion, and sessionID
851 * Returns NULL if no such client
854 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
855 struct nfs4_sessionid *sid, u32 minorversion)
857 struct nfs_client *clp;
858 struct nfs_net *nn = net_generic(net, nfs_net_id);
860 spin_lock(&nn->nfs_client_lock);
861 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
862 if (!nfs4_cb_match_client(addr, clp, minorversion))
865 if (!nfs4_has_session(clp))
869 if (memcmp(clp->cl_session->sess_id.data,
870 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
873 refcount_inc(&clp->cl_count);
874 spin_unlock(&nn->nfs_client_lock);
877 spin_unlock(&nn->nfs_client_lock);
881 #else /* CONFIG_NFS_V4_1 */
884 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
885 struct nfs4_sessionid *sid, u32 minorversion)
889 #endif /* CONFIG_NFS_V4_1 */
892 * Set up an NFS4 client
894 static int nfs4_set_client(struct nfs_server *server,
895 const char *hostname,
896 const struct sockaddr_storage *addr,
897 const size_t addrlen,
899 int proto, const struct rpc_timeout *timeparms,
900 u32 minorversion, unsigned int nconnect,
901 unsigned int max_connect,
903 struct xprtsec_parms *xprtsec)
905 struct nfs_client_initdata cl_init = {
906 .hostname = hostname,
912 .minorversion = minorversion,
914 .timeparms = timeparms,
915 .cred = server->cred,
918 struct nfs_client *clp;
920 if (minorversion == 0)
921 __set_bit(NFS_CS_REUSEPORT, &cl_init.init_flags);
923 cl_init.max_connect = max_connect;
925 case XPRT_TRANSPORT_TCP:
926 case XPRT_TRANSPORT_TCP_TLS:
927 cl_init.nconnect = nconnect;
930 if (server->flags & NFS_MOUNT_NORESVPORT)
931 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
932 if (server->options & NFS_OPTION_MIGRATION)
933 __set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
934 if (test_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status))
935 __set_bit(NFS_CS_TSM_POSSIBLE, &cl_init.init_flags);
936 server->port = rpc_get_port((struct sockaddr *)addr);
938 /* Allocate or find a client reference we can use */
939 clp = nfs_get_client(&cl_init);
943 if (server->nfs_client == clp) {
949 * Query for the lease time on clientid setup or renewal
951 * Note that this will be set on nfs_clients that were created
952 * only for the DS role and did not set this bit, but now will
955 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
957 server->nfs_client = clp;
958 nfs_sysfs_add_server(server);
959 nfs_sysfs_link_rpc_client(server, clp->cl_rpcclient, "_state");
965 * Set up a pNFS Data Server client.
967 * Return any existing nfs_client that matches server address,port,version
970 * For a new nfs_client, use a soft mount (default), a low retrans and a
971 * low timeout interval so that if a connection is lost, we retry through
974 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
975 const struct sockaddr_storage *ds_addr, int ds_addrlen,
976 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
979 struct rpc_timeout ds_timeout;
980 struct nfs_client *mds_clp = mds_srv->nfs_client;
981 struct nfs_client_initdata cl_init = {
983 .addrlen = ds_addrlen,
984 .nodename = mds_clp->cl_rpcclient->cl_nodename,
985 .ip_addr = mds_clp->cl_ipaddr,
988 .minorversion = minor_version,
989 .net = mds_clp->cl_net,
990 .timeparms = &ds_timeout,
991 .cred = mds_srv->cred,
992 .xprtsec = mds_srv->nfs_client->cl_xprtsec,
994 char buf[INET6_ADDRSTRLEN + 1];
996 if (rpc_ntop((struct sockaddr *)ds_addr, buf, sizeof(buf)) <= 0)
997 return ERR_PTR(-EINVAL);
998 cl_init.hostname = buf;
1001 case XPRT_TRANSPORT_TCP:
1002 case XPRT_TRANSPORT_TCP_TLS:
1003 if (mds_clp->cl_nconnect > 1) {
1004 cl_init.nconnect = mds_clp->cl_nconnect;
1005 cl_init.max_connect = NFS_MAX_TRANSPORTS;
1009 if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
1010 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
1012 __set_bit(NFS_CS_DS, &cl_init.init_flags);
1014 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
1015 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
1016 * (section 13.1 RFC 5661).
1018 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
1019 return nfs_get_client(&cl_init);
1021 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
1024 * Session has been established, and the client marked ready.
1025 * Limit the mount rsize, wsize and dtsize using negotiated fore
1026 * channel attributes.
1028 static void nfs4_session_limit_rwsize(struct nfs_server *server)
1030 #ifdef CONFIG_NFS_V4_1
1031 struct nfs4_session *sess;
1035 if (!nfs4_has_session(server->nfs_client))
1037 sess = server->nfs_client->cl_session;
1038 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1039 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1041 if (server->dtsize > server_resp_sz)
1042 server->dtsize = server_resp_sz;
1043 if (server->rsize > server_resp_sz)
1044 server->rsize = server_resp_sz;
1045 if (server->wsize > server_rqst_sz)
1046 server->wsize = server_rqst_sz;
1047 #endif /* CONFIG_NFS_V4_1 */
1051 * Limit xattr sizes using the channel attributes.
1053 static void nfs4_session_limit_xasize(struct nfs_server *server)
1055 #ifdef CONFIG_NFS_V4_2
1056 struct nfs4_session *sess;
1061 if (!nfs4_has_session(server->nfs_client))
1064 sess = server->nfs_client->cl_session;
1066 server_gxa_sz = sess->fc_attrs.max_resp_sz - nfs42_maxgetxattr_overhead;
1067 server_sxa_sz = sess->fc_attrs.max_rqst_sz - nfs42_maxsetxattr_overhead;
1068 server_lxa_sz = sess->fc_attrs.max_resp_sz -
1069 nfs42_maxlistxattrs_overhead;
1071 if (server->gxasize > server_gxa_sz)
1072 server->gxasize = server_gxa_sz;
1073 if (server->sxasize > server_sxa_sz)
1074 server->sxasize = server_sxa_sz;
1075 if (server->lxasize > server_lxa_sz)
1076 server->lxasize = server_lxa_sz;
1080 void nfs4_server_set_init_caps(struct nfs_server *server)
1082 /* Set the basic capabilities */
1083 server->caps |= server->nfs_client->cl_mvops->init_caps;
1084 if (server->flags & NFS_MOUNT_NORDIRPLUS)
1085 server->caps &= ~NFS_CAP_READDIRPLUS;
1086 if (server->nfs_client->cl_proto == XPRT_TRANSPORT_RDMA)
1087 server->caps &= ~NFS_CAP_READ_PLUS;
1090 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1093 if (nfs4_disable_idmapping &&
1094 server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1095 server->caps |= NFS_CAP_UIDGID_NOMAP;
1098 static int nfs4_server_common_setup(struct nfs_server *server,
1099 struct nfs_fh *mntfh, bool auth_probe)
1103 /* data servers support only a subset of NFSv4.1 */
1104 if (is_ds_only_client(server->nfs_client))
1105 return -EPROTONOSUPPORT;
1107 /* We must ensure the session is initialised first */
1108 error = nfs4_init_session(server->nfs_client);
1112 nfs4_server_set_init_caps(server);
1114 /* Probe the root fh to retrieve its FSID and filehandle */
1115 error = nfs4_get_rootfh(server, mntfh, auth_probe);
1119 dprintk("Server FSID: %llx:%llx\n",
1120 (unsigned long long) server->fsid.major,
1121 (unsigned long long) server->fsid.minor);
1122 nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1124 error = nfs_probe_server(server, mntfh);
1128 nfs4_session_limit_rwsize(server);
1129 nfs4_session_limit_xasize(server);
1131 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1132 server->namelen = NFS4_MAXNAMLEN;
1134 nfs_server_insert_lists(server);
1135 server->mount_time = jiffies;
1136 server->destroy = nfs4_destroy_server;
1142 * Create a version 4 volume record
1144 static int nfs4_init_server(struct nfs_server *server, struct fs_context *fc)
1146 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1147 struct rpc_timeout timeparms;
1150 nfs_init_timeout_values(&timeparms, ctx->nfs_server.protocol,
1151 ctx->timeo, ctx->retrans);
1153 /* Initialise the client representation from the mount data */
1154 server->flags = ctx->flags;
1155 server->options = ctx->options;
1156 server->auth_info = ctx->auth_info;
1158 /* Use the first specified auth flavor. If this flavor isn't
1159 * allowed by the server, use the SECINFO path to try the
1160 * other specified flavors */
1161 if (ctx->auth_info.flavor_len >= 1)
1162 ctx->selected_flavor = ctx->auth_info.flavors[0];
1164 ctx->selected_flavor = RPC_AUTH_UNIX;
1166 /* Get a client record */
1167 error = nfs4_set_client(server,
1168 ctx->nfs_server.hostname,
1169 &ctx->nfs_server._address,
1170 ctx->nfs_server.addrlen,
1171 ctx->client_address,
1172 ctx->nfs_server.protocol,
1175 ctx->nfs_server.nconnect,
1176 ctx->nfs_server.max_connect,
1183 server->rsize = nfs_io_size(ctx->rsize, server->nfs_client->cl_proto);
1185 server->wsize = nfs_io_size(ctx->wsize, server->nfs_client->cl_proto);
1187 server->acregmin = ctx->acregmin * HZ;
1188 server->acregmax = ctx->acregmax * HZ;
1189 server->acdirmin = ctx->acdirmin * HZ;
1190 server->acdirmax = ctx->acdirmax * HZ;
1191 server->port = ctx->nfs_server.port;
1193 return nfs_init_server_rpcclient(server, &timeparms,
1194 ctx->selected_flavor);
1198 * Create a version 4 volume record
1199 * - keyed on server and FSID
1201 struct nfs_server *nfs4_create_server(struct fs_context *fc)
1203 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1204 struct nfs_server *server;
1208 server = nfs_alloc_server();
1210 return ERR_PTR(-ENOMEM);
1212 server->cred = get_cred(fc->cred);
1214 auth_probe = ctx->auth_info.flavor_len < 1;
1216 /* set up the general RPC client */
1217 error = nfs4_init_server(server, fc);
1221 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1228 nfs_free_server(server);
1229 return ERR_PTR(error);
1233 * Create an NFS4 referral server record
1235 struct nfs_server *nfs4_create_referral_server(struct fs_context *fc)
1237 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1238 struct nfs_client *parent_client;
1239 struct nfs_server *server, *parent_server;
1243 server = nfs_alloc_server();
1245 return ERR_PTR(-ENOMEM);
1247 parent_server = NFS_SB(ctx->clone_data.sb);
1248 parent_client = parent_server->nfs_client;
1250 server->cred = get_cred(parent_server->cred);
1252 /* Initialise the client representation from the parent server */
1253 nfs_server_copy_userdata(server, parent_server);
1255 /* Get a client representation */
1256 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1257 rpc_set_port(&ctx->nfs_server.address, NFS_RDMA_PORT);
1258 error = nfs4_set_client(server,
1259 ctx->nfs_server.hostname,
1260 &ctx->nfs_server._address,
1261 ctx->nfs_server.addrlen,
1262 parent_client->cl_ipaddr,
1263 XPRT_TRANSPORT_RDMA,
1264 parent_server->client->cl_timeout,
1265 parent_client->cl_mvops->minor_version,
1266 parent_client->cl_nconnect,
1267 parent_client->cl_max_connect,
1268 parent_client->cl_net,
1269 &parent_client->cl_xprtsec);
1272 #endif /* IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA) */
1274 proto = XPRT_TRANSPORT_TCP;
1275 if (parent_client->cl_xprtsec.policy != RPC_XPRTSEC_NONE)
1276 proto = XPRT_TRANSPORT_TCP_TLS;
1277 rpc_set_port(&ctx->nfs_server.address, NFS_PORT);
1278 error = nfs4_set_client(server,
1279 ctx->nfs_server.hostname,
1280 &ctx->nfs_server._address,
1281 ctx->nfs_server.addrlen,
1282 parent_client->cl_ipaddr,
1284 parent_server->client->cl_timeout,
1285 parent_client->cl_mvops->minor_version,
1286 parent_client->cl_nconnect,
1287 parent_client->cl_max_connect,
1288 parent_client->cl_net,
1289 &parent_client->cl_xprtsec);
1293 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1296 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout,
1297 ctx->selected_flavor);
1301 auth_probe = parent_server->auth_info.flavor_len < 1;
1303 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1310 nfs_free_server(server);
1311 return ERR_PTR(error);
1315 * nfs4_update_server - Move an nfs_server to a different nfs_client
1317 * @server: represents FSID to be moved
1318 * @hostname: new end-point's hostname
1319 * @sap: new end-point's socket address
1320 * @salen: size of "sap"
1321 * @net: net namespace
1323 * The nfs_server must be quiescent before this function is invoked.
1324 * Either its session is drained (NFSv4.1+), or its transport is
1325 * plugged and drained (NFSv4.0).
1327 * Returns zero on success, or a negative errno value.
1329 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1330 struct sockaddr_storage *sap, size_t salen, struct net *net)
1332 struct nfs_client *clp = server->nfs_client;
1333 struct rpc_clnt *clnt = server->client;
1334 struct xprt_create xargs = {
1335 .ident = clp->cl_proto,
1337 .dstaddr = (struct sockaddr *)sap,
1339 .servername = hostname,
1340 /* cel: bleh. We might need to pass TLS parameters here */
1342 char buf[INET6_ADDRSTRLEN + 1];
1343 struct sockaddr_storage address;
1344 struct sockaddr *localaddr = (struct sockaddr *)&address;
1347 error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1351 error = rpc_localaddr(clnt, localaddr, sizeof(address));
1355 if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0)
1356 return -EAFNOSUPPORT;
1358 nfs_server_remove_lists(server);
1359 set_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1360 error = nfs4_set_client(server, hostname, sap, salen, buf,
1361 clp->cl_proto, clnt->cl_timeout,
1362 clp->cl_minorversion,
1363 clp->cl_nconnect, clp->cl_max_connect,
1364 net, &clp->cl_xprtsec);
1365 clear_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1367 nfs_server_insert_lists(server);
1370 nfs_put_client(clp);
1372 if (server->nfs_client->cl_hostname == NULL) {
1373 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1374 if (server->nfs_client->cl_hostname == NULL)
1377 nfs_server_insert_lists(server);
1379 return nfs_probe_server(server, NFS_FH(d_inode(server->super->s_root)));