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"
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,
420 int max_connect = test_bit(NFS_CS_PNFS, &clp->cl_flags) ?
421 clp->cl_max_connect : old->cl_max_connect;
423 if (clp->cl_proto != old->cl_proto)
425 clp_salen = rpc_peeraddr(clp->cl_rpcclient, clp_sap, sizeof(clp_addr));
426 rpc_peeraddr(old->cl_rpcclient, old_sap, sizeof(old_addr));
428 if (clp_addr.ss_family != old_addr.ss_family)
431 xprt_args.dstaddr = clp_sap;
432 xprt_args.addrlen = clp_salen;
434 rpc_clnt_add_xprt(old->cl_rpcclient, &xprt_args,
435 rpc_clnt_test_and_add_xprt, &max_connect);
439 * nfs4_init_client - Initialise an NFS4 client record
441 * @clp: nfs_client to initialise
442 * @cl_init: pointer to nfs_client_initdata
444 * Returns pointer to an NFS client, or an ERR_PTR value.
446 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
447 const struct nfs_client_initdata *cl_init)
449 struct nfs_client *old;
452 if (clp->cl_cons_state == NFS_CS_READY)
453 /* the client is initialised already */
456 error = nfs4_init_client_minor_version(clp);
460 error = nfs4_discover_server_trunking(clp, &old);
465 clp->cl_preserve_clid = true;
467 * Mark the client as having failed initialization so other
468 * processes walking the nfs_client_list in nfs_match_client()
469 * won't try to use it.
471 nfs_mark_client_ready(clp, -EPERM);
472 if (old->cl_mvops->session_trunk)
473 nfs4_add_trunk(clp, old);
475 clear_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags);
480 nfs_mark_client_ready(clp, error);
482 return ERR_PTR(error);
486 * SETCLIENTID just did a callback update with the callback ident in
487 * "drop," but server trunking discovery claims "drop" and "keep" are
488 * actually the same server. Swap the callback IDs so that "keep"
489 * will continue to use the callback ident the server now knows about,
490 * and so that "keep"'s original callback ident is destroyed when
493 static void nfs4_swap_callback_idents(struct nfs_client *keep,
494 struct nfs_client *drop)
496 struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
497 unsigned int save = keep->cl_cb_ident;
499 if (keep->cl_cb_ident == drop->cl_cb_ident)
502 dprintk("%s: keeping callback ident %u and dropping ident %u\n",
503 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
505 spin_lock(&nn->nfs_client_lock);
507 idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
508 keep->cl_cb_ident = drop->cl_cb_ident;
510 idr_replace(&nn->cb_ident_idr, drop, save);
511 drop->cl_cb_ident = save;
513 spin_unlock(&nn->nfs_client_lock);
516 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
517 const struct nfs_client *clp2)
519 if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
521 return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
524 static bool nfs4_same_verifier(nfs4_verifier *v1, nfs4_verifier *v2)
526 return memcmp(v1->data, v2->data, sizeof(v1->data)) == 0;
529 static int nfs4_match_client(struct nfs_client *pos, struct nfs_client *new,
530 struct nfs_client **prev, struct nfs_net *nn)
534 if (pos->rpc_ops != new->rpc_ops)
537 if (pos->cl_minorversion != new->cl_minorversion)
540 /* If "pos" isn't marked ready, we can't trust the
541 * remaining fields in "pos", especially the client
542 * ID and serverowner fields. Wait for CREATE_SESSION
544 if (pos->cl_cons_state > NFS_CS_READY) {
545 refcount_inc(&pos->cl_count);
546 spin_unlock(&nn->nfs_client_lock);
548 nfs_put_client(*prev);
551 status = nfs_wait_client_init_complete(pos);
552 spin_lock(&nn->nfs_client_lock);
558 if (pos->cl_cons_state != NFS_CS_READY)
561 if (pos->cl_clientid != new->cl_clientid)
564 /* NFSv4.1 always uses the uniform string, however someone
565 * might switch the uniquifier string on us.
567 if (!nfs4_match_client_owner_id(pos, new))
574 * nfs40_walk_client_list - Find server that recognizes a client ID
576 * @new: nfs_client with client ID to test
577 * @result: OUT: found nfs_client, or new
578 * @cred: credential to use for trunking test
580 * Returns zero, a negative errno, or a negative NFS4ERR status.
581 * If zero is returned, an nfs_client pointer is planted in "result."
583 * NB: nfs40_walk_client_list() relies on the new nfs_client being
584 * the last nfs_client on the list.
586 int nfs40_walk_client_list(struct nfs_client *new,
587 struct nfs_client **result,
588 const struct cred *cred)
590 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
591 struct nfs_client *pos, *prev = NULL;
592 struct nfs4_setclientid_res clid = {
593 .clientid = new->cl_clientid,
594 .confirm = new->cl_confirm,
596 int status = -NFS4ERR_STALE_CLIENTID;
598 spin_lock(&nn->nfs_client_lock);
599 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
604 status = nfs4_match_client(pos, new, &prev, nn);
610 * We just sent a new SETCLIENTID, which should have
611 * caused the server to return a new cl_confirm. So if
612 * cl_confirm is the same, then this is a different
613 * server that just returned the same cl_confirm by
616 if ((new != pos) && nfs4_same_verifier(&pos->cl_confirm,
620 * But if the cl_confirm's are different, then the only
621 * way that a SETCLIENTID_CONFIRM to pos can succeed is
622 * if new and pos point to the same server:
625 refcount_inc(&pos->cl_count);
626 spin_unlock(&nn->nfs_client_lock);
628 nfs_put_client(prev);
631 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
633 case -NFS4ERR_STALE_CLIENTID:
636 nfs4_swap_callback_idents(pos, new);
637 pos->cl_confirm = new->cl_confirm;
638 nfs_mark_client_ready(pos, NFS_CS_READY);
645 /* The callback path may have been inadvertently
646 * changed. Schedule recovery!
648 nfs4_schedule_path_down_recovery(pos);
654 spin_lock(&nn->nfs_client_lock);
657 spin_unlock(&nn->nfs_client_lock);
659 /* No match found. The server lost our clientid */
661 nfs_put_client(prev);
665 #ifdef CONFIG_NFS_V4_1
667 * Returns true if the server major ids match
670 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
671 struct nfs41_server_owner *o2)
673 if (o1->major_id_sz != o2->major_id_sz)
675 return memcmp(o1->major_id, o2->major_id, o1->major_id_sz) == 0;
679 * Returns true if the server scopes match
682 nfs4_check_server_scope(struct nfs41_server_scope *s1,
683 struct nfs41_server_scope *s2)
685 if (s1->server_scope_sz != s2->server_scope_sz)
687 return memcmp(s1->server_scope, s2->server_scope,
688 s1->server_scope_sz) == 0;
692 * nfs4_detect_session_trunking - Checks for session trunking.
693 * @clp: original mount nfs_client
694 * @res: result structure from an exchange_id using the original mount
695 * nfs_client with a new multi_addr transport
696 * @xprt: pointer to the transport to add.
698 * Called after a successful EXCHANGE_ID on a multi-addr connection.
699 * Upon success, add the transport.
701 * Returns zero on success, otherwise -EINVAL
703 * Note: since the exchange_id for the new multi_addr transport uses the
704 * same nfs_client from the original mount, the cl_owner_id is reused,
705 * so eir_clientowner is the same.
707 int nfs4_detect_session_trunking(struct nfs_client *clp,
708 struct nfs41_exchange_id_res *res,
709 struct rpc_xprt *xprt)
711 /* Check eir_clientid */
712 if (clp->cl_clientid != res->clientid)
715 /* Check eir_server_owner so_major_id */
716 if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
720 /* Check eir_server_owner so_minor_id */
721 if (clp->cl_serverowner->minor_id != res->server_owner->minor_id)
724 /* Check eir_server_scope */
725 if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
728 pr_info("NFS: %s: Session trunking succeeded for %s\n",
730 xprt->address_strings[RPC_DISPLAY_ADDR]);
734 pr_info("NFS: %s: Session trunking failed for %s\n", clp->cl_hostname,
735 xprt->address_strings[RPC_DISPLAY_ADDR]);
741 * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
743 * @new: nfs_client with client ID to test
744 * @result: OUT: found nfs_client, or new
745 * @cred: credential to use for trunking test
747 * Returns zero, a negative errno, or a negative NFS4ERR status.
748 * If zero is returned, an nfs_client pointer is planted in "result."
750 * NB: nfs41_walk_client_list() relies on the new nfs_client being
751 * the last nfs_client on the list.
753 int nfs41_walk_client_list(struct nfs_client *new,
754 struct nfs_client **result,
755 const struct cred *cred)
757 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
758 struct nfs_client *pos, *prev = NULL;
759 int status = -NFS4ERR_STALE_CLIENTID;
761 spin_lock(&nn->nfs_client_lock);
762 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
767 status = nfs4_match_client(pos, new, &prev, nn);
774 * Note that session trunking is just a special subcase of
775 * client id trunking. In either case, we want to fall back
776 * to using the existing nfs_client.
778 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
779 new->cl_serverowner))
783 refcount_inc(&pos->cl_count);
790 spin_unlock(&nn->nfs_client_lock);
791 nfs_put_client(prev);
794 #endif /* CONFIG_NFS_V4_1 */
796 static void nfs4_destroy_server(struct nfs_server *server)
800 nfs_server_return_all_delegations(server);
801 unset_pnfs_layoutdriver(server);
802 nfs4_purge_state_owners(server, &freeme);
803 nfs4_free_state_owners(&freeme);
807 * NFSv4.0 callback thread helper
809 * Find a client by callback identifier
812 nfs4_find_client_ident(struct net *net, int cb_ident)
814 struct nfs_client *clp;
815 struct nfs_net *nn = net_generic(net, nfs_net_id);
817 spin_lock(&nn->nfs_client_lock);
818 clp = idr_find(&nn->cb_ident_idr, cb_ident);
820 refcount_inc(&clp->cl_count);
821 spin_unlock(&nn->nfs_client_lock);
825 #if defined(CONFIG_NFS_V4_1)
826 /* Common match routine for v4.0 and v4.1 callback services */
827 static bool nfs4_cb_match_client(const struct sockaddr *addr,
828 struct nfs_client *clp, u32 minorversion)
830 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
832 /* Don't match clients that failed to initialise */
833 if (!(clp->cl_cons_state == NFS_CS_READY ||
834 clp->cl_cons_state == NFS_CS_SESSION_INITING))
839 /* Match the version and minorversion */
840 if (clp->rpc_ops->version != 4 ||
841 clp->cl_minorversion != minorversion)
844 /* Match only the IP address, not the port number */
845 return rpc_cmp_addr(addr, clap);
849 * NFSv4.1 callback thread helper
850 * For CB_COMPOUND calls, find a client by IP address, protocol version,
851 * minorversion, and sessionID
853 * Returns NULL if no such client
856 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
857 struct nfs4_sessionid *sid, u32 minorversion)
859 struct nfs_client *clp;
860 struct nfs_net *nn = net_generic(net, nfs_net_id);
862 spin_lock(&nn->nfs_client_lock);
863 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
864 if (!nfs4_cb_match_client(addr, clp, minorversion))
867 if (!nfs4_has_session(clp))
871 if (memcmp(clp->cl_session->sess_id.data,
872 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
875 refcount_inc(&clp->cl_count);
876 spin_unlock(&nn->nfs_client_lock);
879 spin_unlock(&nn->nfs_client_lock);
883 #else /* CONFIG_NFS_V4_1 */
886 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
887 struct nfs4_sessionid *sid, u32 minorversion)
891 #endif /* CONFIG_NFS_V4_1 */
894 * Set up an NFS4 client
896 static int nfs4_set_client(struct nfs_server *server,
897 const char *hostname,
898 const struct sockaddr_storage *addr,
899 const size_t addrlen,
901 int proto, const struct rpc_timeout *timeparms,
902 u32 minorversion, unsigned int nconnect,
903 unsigned int max_connect,
905 struct xprtsec_parms *xprtsec)
907 struct nfs_client_initdata cl_init = {
908 .hostname = hostname,
914 .minorversion = minorversion,
916 .timeparms = timeparms,
917 .cred = server->cred,
920 struct nfs_client *clp;
922 if (minorversion == 0)
923 __set_bit(NFS_CS_REUSEPORT, &cl_init.init_flags);
925 cl_init.max_connect = max_connect;
927 case XPRT_TRANSPORT_TCP:
928 case XPRT_TRANSPORT_TCP_TLS:
929 cl_init.nconnect = nconnect;
932 if (server->flags & NFS_MOUNT_NORESVPORT)
933 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
934 if (server->options & NFS_OPTION_MIGRATION)
935 __set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
936 if (test_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status))
937 __set_bit(NFS_CS_TSM_POSSIBLE, &cl_init.init_flags);
938 server->port = rpc_get_port((struct sockaddr *)addr);
940 /* Allocate or find a client reference we can use */
941 clp = nfs_get_client(&cl_init);
945 if (server->nfs_client == clp) {
951 * Query for the lease time on clientid setup or renewal
953 * Note that this will be set on nfs_clients that were created
954 * only for the DS role and did not set this bit, but now will
957 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
959 server->nfs_client = clp;
960 nfs_sysfs_add_server(server);
961 nfs_sysfs_link_rpc_client(server, clp->cl_rpcclient, "_state");
967 * Set up a pNFS Data Server client.
969 * Return any existing nfs_client that matches server address,port,version
972 * For a new nfs_client, use a soft mount (default), a low retrans and a
973 * low timeout interval so that if a connection is lost, we retry through
976 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
977 const struct sockaddr_storage *ds_addr, int ds_addrlen,
978 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
981 struct rpc_timeout ds_timeout;
982 struct nfs_client *mds_clp = mds_srv->nfs_client;
983 struct nfs_client_initdata cl_init = {
985 .addrlen = ds_addrlen,
986 .nodename = mds_clp->cl_rpcclient->cl_nodename,
987 .ip_addr = mds_clp->cl_ipaddr,
990 .minorversion = minor_version,
991 .net = mds_clp->cl_net,
992 .timeparms = &ds_timeout,
993 .cred = mds_srv->cred,
994 .xprtsec = mds_srv->nfs_client->cl_xprtsec,
996 char buf[INET6_ADDRSTRLEN + 1];
998 if (rpc_ntop((struct sockaddr *)ds_addr, buf, sizeof(buf)) <= 0)
999 return ERR_PTR(-EINVAL);
1000 cl_init.hostname = buf;
1003 case XPRT_TRANSPORT_TCP:
1004 case XPRT_TRANSPORT_TCP_TLS:
1005 if (mds_clp->cl_nconnect > 1) {
1006 cl_init.nconnect = mds_clp->cl_nconnect;
1007 cl_init.max_connect = NFS_MAX_TRANSPORTS;
1011 if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
1012 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
1014 __set_bit(NFS_CS_DS, &cl_init.init_flags);
1015 __set_bit(NFS_CS_PNFS, &cl_init.init_flags);
1016 cl_init.max_connect = NFS_MAX_TRANSPORTS;
1018 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
1019 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
1020 * (section 13.1 RFC 5661).
1022 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
1023 return nfs_get_client(&cl_init);
1025 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
1028 * Session has been established, and the client marked ready.
1029 * Limit the mount rsize, wsize and dtsize using negotiated fore
1030 * channel attributes.
1032 static void nfs4_session_limit_rwsize(struct nfs_server *server)
1034 #ifdef CONFIG_NFS_V4_1
1035 struct nfs4_session *sess;
1039 if (!nfs4_has_session(server->nfs_client))
1041 sess = server->nfs_client->cl_session;
1042 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1043 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1045 if (server->dtsize > server_resp_sz)
1046 server->dtsize = server_resp_sz;
1047 if (server->rsize > server_resp_sz)
1048 server->rsize = server_resp_sz;
1049 if (server->wsize > server_rqst_sz)
1050 server->wsize = server_rqst_sz;
1051 #endif /* CONFIG_NFS_V4_1 */
1055 * Limit xattr sizes using the channel attributes.
1057 static void nfs4_session_limit_xasize(struct nfs_server *server)
1059 #ifdef CONFIG_NFS_V4_2
1060 struct nfs4_session *sess;
1065 if (!nfs4_has_session(server->nfs_client))
1068 sess = server->nfs_client->cl_session;
1070 server_gxa_sz = sess->fc_attrs.max_resp_sz - nfs42_maxgetxattr_overhead;
1071 server_sxa_sz = sess->fc_attrs.max_rqst_sz - nfs42_maxsetxattr_overhead;
1072 server_lxa_sz = sess->fc_attrs.max_resp_sz -
1073 nfs42_maxlistxattrs_overhead;
1075 if (server->gxasize > server_gxa_sz)
1076 server->gxasize = server_gxa_sz;
1077 if (server->sxasize > server_sxa_sz)
1078 server->sxasize = server_sxa_sz;
1079 if (server->lxasize > server_lxa_sz)
1080 server->lxasize = server_lxa_sz;
1084 void nfs4_server_set_init_caps(struct nfs_server *server)
1086 /* Set the basic capabilities */
1087 server->caps |= server->nfs_client->cl_mvops->init_caps;
1088 if (server->flags & NFS_MOUNT_NORDIRPLUS)
1089 server->caps &= ~NFS_CAP_READDIRPLUS;
1090 if (server->nfs_client->cl_proto == XPRT_TRANSPORT_RDMA)
1091 server->caps &= ~NFS_CAP_READ_PLUS;
1094 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1097 if (nfs4_disable_idmapping &&
1098 server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1099 server->caps |= NFS_CAP_UIDGID_NOMAP;
1102 static int nfs4_server_common_setup(struct nfs_server *server,
1103 struct nfs_fh *mntfh, bool auth_probe)
1107 /* data servers support only a subset of NFSv4.1 */
1108 if (is_ds_only_client(server->nfs_client))
1109 return -EPROTONOSUPPORT;
1111 /* We must ensure the session is initialised first */
1112 error = nfs4_init_session(server->nfs_client);
1116 nfs4_server_set_init_caps(server);
1118 /* Probe the root fh to retrieve its FSID and filehandle */
1119 error = nfs4_get_rootfh(server, mntfh, auth_probe);
1123 dprintk("Server FSID: %llx:%llx\n",
1124 (unsigned long long) server->fsid.major,
1125 (unsigned long long) server->fsid.minor);
1126 nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1128 error = nfs_probe_server(server, mntfh);
1132 nfs4_session_limit_rwsize(server);
1133 nfs4_session_limit_xasize(server);
1135 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1136 server->namelen = NFS4_MAXNAMLEN;
1138 nfs_server_insert_lists(server);
1139 server->mount_time = jiffies;
1140 server->destroy = nfs4_destroy_server;
1146 * Create a version 4 volume record
1148 static int nfs4_init_server(struct nfs_server *server, struct fs_context *fc)
1150 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1151 struct rpc_timeout timeparms;
1154 nfs_init_timeout_values(&timeparms, ctx->nfs_server.protocol,
1155 ctx->timeo, ctx->retrans);
1157 /* Initialise the client representation from the mount data */
1158 server->flags = ctx->flags;
1159 server->options = ctx->options;
1160 server->auth_info = ctx->auth_info;
1162 /* Use the first specified auth flavor. If this flavor isn't
1163 * allowed by the server, use the SECINFO path to try the
1164 * other specified flavors */
1165 if (ctx->auth_info.flavor_len >= 1)
1166 ctx->selected_flavor = ctx->auth_info.flavors[0];
1168 ctx->selected_flavor = RPC_AUTH_UNIX;
1170 /* Get a client record */
1171 error = nfs4_set_client(server,
1172 ctx->nfs_server.hostname,
1173 &ctx->nfs_server._address,
1174 ctx->nfs_server.addrlen,
1175 ctx->client_address,
1176 ctx->nfs_server.protocol,
1179 ctx->nfs_server.nconnect,
1180 ctx->nfs_server.max_connect,
1187 server->rsize = nfs_io_size(ctx->rsize, server->nfs_client->cl_proto);
1189 server->wsize = nfs_io_size(ctx->wsize, server->nfs_client->cl_proto);
1191 server->acregmin = ctx->acregmin * HZ;
1192 server->acregmax = ctx->acregmax * HZ;
1193 server->acdirmin = ctx->acdirmin * HZ;
1194 server->acdirmax = ctx->acdirmax * HZ;
1195 server->port = ctx->nfs_server.port;
1197 return nfs_init_server_rpcclient(server, &timeparms,
1198 ctx->selected_flavor);
1202 * Create a version 4 volume record
1203 * - keyed on server and FSID
1205 struct nfs_server *nfs4_create_server(struct fs_context *fc)
1207 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1208 struct nfs_server *server;
1212 server = nfs_alloc_server();
1214 return ERR_PTR(-ENOMEM);
1216 server->cred = get_cred(fc->cred);
1218 auth_probe = ctx->auth_info.flavor_len < 1;
1220 /* set up the general RPC client */
1221 error = nfs4_init_server(server, fc);
1225 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1232 nfs_free_server(server);
1233 return ERR_PTR(error);
1237 * Create an NFS4 referral server record
1239 struct nfs_server *nfs4_create_referral_server(struct fs_context *fc)
1241 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1242 struct nfs_client *parent_client;
1243 struct nfs_server *server, *parent_server;
1247 server = nfs_alloc_server();
1249 return ERR_PTR(-ENOMEM);
1251 parent_server = NFS_SB(ctx->clone_data.sb);
1252 parent_client = parent_server->nfs_client;
1254 server->cred = get_cred(parent_server->cred);
1256 /* Initialise the client representation from the parent server */
1257 nfs_server_copy_userdata(server, parent_server);
1259 /* Get a client representation */
1260 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1261 rpc_set_port(&ctx->nfs_server.address, NFS_RDMA_PORT);
1262 error = nfs4_set_client(server,
1263 ctx->nfs_server.hostname,
1264 &ctx->nfs_server._address,
1265 ctx->nfs_server.addrlen,
1266 parent_client->cl_ipaddr,
1267 XPRT_TRANSPORT_RDMA,
1268 parent_server->client->cl_timeout,
1269 parent_client->cl_mvops->minor_version,
1270 parent_client->cl_nconnect,
1271 parent_client->cl_max_connect,
1272 parent_client->cl_net,
1273 &parent_client->cl_xprtsec);
1276 #endif /* IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA) */
1278 proto = XPRT_TRANSPORT_TCP;
1279 if (parent_client->cl_xprtsec.policy != RPC_XPRTSEC_NONE)
1280 proto = XPRT_TRANSPORT_TCP_TLS;
1281 rpc_set_port(&ctx->nfs_server.address, NFS_PORT);
1282 error = nfs4_set_client(server,
1283 ctx->nfs_server.hostname,
1284 &ctx->nfs_server._address,
1285 ctx->nfs_server.addrlen,
1286 parent_client->cl_ipaddr,
1288 parent_server->client->cl_timeout,
1289 parent_client->cl_mvops->minor_version,
1290 parent_client->cl_nconnect,
1291 parent_client->cl_max_connect,
1292 parent_client->cl_net,
1293 &parent_client->cl_xprtsec);
1297 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1300 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout,
1301 ctx->selected_flavor);
1305 auth_probe = parent_server->auth_info.flavor_len < 1;
1307 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1314 nfs_free_server(server);
1315 return ERR_PTR(error);
1319 * nfs4_update_server - Move an nfs_server to a different nfs_client
1321 * @server: represents FSID to be moved
1322 * @hostname: new end-point's hostname
1323 * @sap: new end-point's socket address
1324 * @salen: size of "sap"
1325 * @net: net namespace
1327 * The nfs_server must be quiescent before this function is invoked.
1328 * Either its session is drained (NFSv4.1+), or its transport is
1329 * plugged and drained (NFSv4.0).
1331 * Returns zero on success, or a negative errno value.
1333 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1334 struct sockaddr_storage *sap, size_t salen, struct net *net)
1336 struct nfs_client *clp = server->nfs_client;
1337 struct rpc_clnt *clnt = server->client;
1338 struct xprt_create xargs = {
1339 .ident = clp->cl_proto,
1341 .dstaddr = (struct sockaddr *)sap,
1343 .servername = hostname,
1344 /* cel: bleh. We might need to pass TLS parameters here */
1346 char buf[INET6_ADDRSTRLEN + 1];
1347 struct sockaddr_storage address;
1348 struct sockaddr *localaddr = (struct sockaddr *)&address;
1351 error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1355 error = rpc_localaddr(clnt, localaddr, sizeof(address));
1359 if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0)
1360 return -EAFNOSUPPORT;
1362 nfs_server_remove_lists(server);
1363 set_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1364 error = nfs4_set_client(server, hostname, sap, salen, buf,
1365 clp->cl_proto, clnt->cl_timeout,
1366 clp->cl_minorversion,
1367 clp->cl_nconnect, clp->cl_max_connect,
1368 net, &clp->cl_xprtsec);
1369 clear_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1371 nfs_server_insert_lists(server);
1374 nfs_put_client(clp);
1376 if (server->nfs_client->cl_hostname == NULL) {
1377 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1378 if (server->nfs_client->cl_hostname == NULL)
1381 nfs_server_insert_lists(server);
1383 return nfs_probe_server(server, NFS_FH(d_inode(server->super->s_root)));