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);
236 * Set up the connection to the server before we add add to the
239 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_GSS_KRB5I);
241 err = nfs_create_rpc_client(clp, cl_init, RPC_AUTH_UNIX);
245 /* If no clientaddr= option was specified, find a usable cb address */
246 if (ip_addr == NULL) {
247 struct sockaddr_storage cb_addr;
248 struct sockaddr *sap = (struct sockaddr *)&cb_addr;
250 err = rpc_localaddr(clp->cl_rpcclient, sap, sizeof(cb_addr));
253 err = rpc_ntop(sap, buf, sizeof(buf));
256 ip_addr = (const char *)buf;
258 strscpy(clp->cl_ipaddr, ip_addr, sizeof(clp->cl_ipaddr));
260 err = nfs_idmap_new(clp);
262 dprintk("%s: failed to create idmapper. Error = %d\n",
266 __set_bit(NFS_CS_IDMAP, &clp->cl_res_state);
270 nfs_free_client(clp);
275 * Destroy the NFS4 callback service
277 static void nfs4_destroy_callback(struct nfs_client *clp)
279 if (__test_and_clear_bit(NFS_CS_CALLBACK, &clp->cl_res_state))
280 nfs_callback_down(clp->cl_mvops->minor_version, clp->cl_net);
283 static void nfs4_shutdown_client(struct nfs_client *clp)
285 if (__test_and_clear_bit(NFS_CS_RENEWD, &clp->cl_res_state))
286 nfs4_kill_renewd(clp);
287 clp->cl_mvops->shutdown_client(clp);
288 nfs4_destroy_callback(clp);
289 if (__test_and_clear_bit(NFS_CS_IDMAP, &clp->cl_res_state))
290 nfs_idmap_delete(clp);
292 rpc_destroy_wait_queue(&clp->cl_rpcwaitq);
293 kfree(clp->cl_serverowner);
294 kfree(clp->cl_serverscope);
295 kfree(clp->cl_implid);
296 kfree(clp->cl_owner_id);
299 void nfs4_free_client(struct nfs_client *clp)
301 nfs4_shutdown_client(clp);
302 nfs_free_client(clp);
306 * Initialize the NFS4 callback service
308 static int nfs4_init_callback(struct nfs_client *clp)
310 struct rpc_xprt *xprt;
313 xprt = rcu_dereference_raw(clp->cl_rpcclient->cl_xprt);
315 if (nfs4_has_session(clp)) {
316 error = xprt_setup_backchannel(xprt, NFS41_BC_MIN_CALLBACKS);
321 error = nfs_callback_up(clp->cl_mvops->minor_version, xprt);
323 dprintk("%s: failed to start callback. Error = %d\n",
327 __set_bit(NFS_CS_CALLBACK, &clp->cl_res_state);
333 * nfs40_init_client - nfs_client initialization tasks for NFSv4.0
334 * @clp: nfs_client to initialize
336 * Returns zero on success, or a negative errno if some error occurred.
338 int nfs40_init_client(struct nfs_client *clp)
340 struct nfs4_slot_table *tbl;
343 tbl = kzalloc(sizeof(*tbl), GFP_NOFS);
347 ret = nfs4_setup_slot_table(tbl, NFS4_MAX_SLOT_TABLE,
348 "NFSv4.0 transport Slot table");
350 nfs4_shutdown_slot_table(tbl);
355 clp->cl_slot_tbl = tbl;
359 #if defined(CONFIG_NFS_V4_1)
362 * nfs41_init_client - nfs_client initialization tasks for NFSv4.1+
363 * @clp: nfs_client to initialize
365 * Returns zero on success, or a negative errno if some error occurred.
367 int nfs41_init_client(struct nfs_client *clp)
369 struct nfs4_session *session = NULL;
372 * Create the session and mark it expired.
373 * When a SEQUENCE operation encounters the expired session
374 * it will do session recovery to initialize it.
376 session = nfs4_alloc_session(clp);
380 clp->cl_session = session;
383 * The create session reply races with the server back
384 * channel probe. Mark the client NFS_CS_SESSION_INITING
385 * so that the client back channel can find the
388 nfs_mark_client_ready(clp, NFS_CS_SESSION_INITING);
392 #endif /* CONFIG_NFS_V4_1 */
395 * Initialize the minor version specific parts of an NFS4 client record
397 static int nfs4_init_client_minor_version(struct nfs_client *clp)
401 ret = clp->cl_mvops->init_client(clp);
404 return nfs4_init_callback(clp);
407 static void nfs4_add_trunk(struct nfs_client *clp, struct nfs_client *old)
409 struct sockaddr_storage clp_addr, old_addr;
410 struct sockaddr *clp_sap = (struct sockaddr *)&clp_addr;
411 struct sockaddr *old_sap = (struct sockaddr *)&old_addr;
413 struct xprt_create xprt_args = {
414 .ident = old->cl_proto,
416 .servername = old->cl_hostname,
419 if (clp->cl_proto != old->cl_proto)
421 clp_salen = rpc_peeraddr(clp->cl_rpcclient, clp_sap, sizeof(clp_addr));
422 rpc_peeraddr(old->cl_rpcclient, old_sap, sizeof(old_addr));
424 if (clp_addr.ss_family != old_addr.ss_family)
427 xprt_args.dstaddr = clp_sap;
428 xprt_args.addrlen = clp_salen;
430 rpc_clnt_add_xprt(old->cl_rpcclient, &xprt_args,
431 rpc_clnt_test_and_add_xprt, NULL);
435 * nfs4_init_client - Initialise an NFS4 client record
437 * @clp: nfs_client to initialise
438 * @cl_init: pointer to nfs_client_initdata
440 * Returns pointer to an NFS client, or an ERR_PTR value.
442 struct nfs_client *nfs4_init_client(struct nfs_client *clp,
443 const struct nfs_client_initdata *cl_init)
445 struct nfs_client *old;
448 if (clp->cl_cons_state == NFS_CS_READY)
449 /* the client is initialised already */
452 error = nfs4_init_client_minor_version(clp);
456 error = nfs4_discover_server_trunking(clp, &old);
461 clp->cl_preserve_clid = true;
463 * Mark the client as having failed initialization so other
464 * processes walking the nfs_client_list in nfs_match_client()
465 * won't try to use it.
467 nfs_mark_client_ready(clp, -EPERM);
468 if (old->cl_mvops->session_trunk)
469 nfs4_add_trunk(clp, old);
471 clear_bit(NFS_CS_TSM_POSSIBLE, &clp->cl_flags);
476 nfs_mark_client_ready(clp, error);
478 return ERR_PTR(error);
482 * SETCLIENTID just did a callback update with the callback ident in
483 * "drop," but server trunking discovery claims "drop" and "keep" are
484 * actually the same server. Swap the callback IDs so that "keep"
485 * will continue to use the callback ident the server now knows about,
486 * and so that "keep"'s original callback ident is destroyed when
489 static void nfs4_swap_callback_idents(struct nfs_client *keep,
490 struct nfs_client *drop)
492 struct nfs_net *nn = net_generic(keep->cl_net, nfs_net_id);
493 unsigned int save = keep->cl_cb_ident;
495 if (keep->cl_cb_ident == drop->cl_cb_ident)
498 dprintk("%s: keeping callback ident %u and dropping ident %u\n",
499 __func__, keep->cl_cb_ident, drop->cl_cb_ident);
501 spin_lock(&nn->nfs_client_lock);
503 idr_replace(&nn->cb_ident_idr, keep, drop->cl_cb_ident);
504 keep->cl_cb_ident = drop->cl_cb_ident;
506 idr_replace(&nn->cb_ident_idr, drop, save);
507 drop->cl_cb_ident = save;
509 spin_unlock(&nn->nfs_client_lock);
512 static bool nfs4_match_client_owner_id(const struct nfs_client *clp1,
513 const struct nfs_client *clp2)
515 if (clp1->cl_owner_id == NULL || clp2->cl_owner_id == NULL)
517 return strcmp(clp1->cl_owner_id, clp2->cl_owner_id) == 0;
520 static bool nfs4_same_verifier(nfs4_verifier *v1, nfs4_verifier *v2)
522 return memcmp(v1->data, v2->data, sizeof(v1->data)) == 0;
525 static int nfs4_match_client(struct nfs_client *pos, struct nfs_client *new,
526 struct nfs_client **prev, struct nfs_net *nn)
530 if (pos->rpc_ops != new->rpc_ops)
533 if (pos->cl_minorversion != new->cl_minorversion)
536 /* If "pos" isn't marked ready, we can't trust the
537 * remaining fields in "pos", especially the client
538 * ID and serverowner fields. Wait for CREATE_SESSION
540 if (pos->cl_cons_state > NFS_CS_READY) {
541 refcount_inc(&pos->cl_count);
542 spin_unlock(&nn->nfs_client_lock);
544 nfs_put_client(*prev);
547 status = nfs_wait_client_init_complete(pos);
548 spin_lock(&nn->nfs_client_lock);
554 if (pos->cl_cons_state != NFS_CS_READY)
557 if (pos->cl_clientid != new->cl_clientid)
560 /* NFSv4.1 always uses the uniform string, however someone
561 * might switch the uniquifier string on us.
563 if (!nfs4_match_client_owner_id(pos, new))
570 * nfs40_walk_client_list - Find server that recognizes a client ID
572 * @new: nfs_client with client ID to test
573 * @result: OUT: found nfs_client, or new
574 * @cred: credential to use for trunking test
576 * Returns zero, a negative errno, or a negative NFS4ERR status.
577 * If zero is returned, an nfs_client pointer is planted in "result."
579 * NB: nfs40_walk_client_list() relies on the new nfs_client being
580 * the last nfs_client on the list.
582 int nfs40_walk_client_list(struct nfs_client *new,
583 struct nfs_client **result,
584 const struct cred *cred)
586 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
587 struct nfs_client *pos, *prev = NULL;
588 struct nfs4_setclientid_res clid = {
589 .clientid = new->cl_clientid,
590 .confirm = new->cl_confirm,
592 int status = -NFS4ERR_STALE_CLIENTID;
594 spin_lock(&nn->nfs_client_lock);
595 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
600 status = nfs4_match_client(pos, new, &prev, nn);
606 * We just sent a new SETCLIENTID, which should have
607 * caused the server to return a new cl_confirm. So if
608 * cl_confirm is the same, then this is a different
609 * server that just returned the same cl_confirm by
612 if ((new != pos) && nfs4_same_verifier(&pos->cl_confirm,
616 * But if the cl_confirm's are different, then the only
617 * way that a SETCLIENTID_CONFIRM to pos can succeed is
618 * if new and pos point to the same server:
621 refcount_inc(&pos->cl_count);
622 spin_unlock(&nn->nfs_client_lock);
624 nfs_put_client(prev);
627 status = nfs4_proc_setclientid_confirm(pos, &clid, cred);
629 case -NFS4ERR_STALE_CLIENTID:
632 nfs4_swap_callback_idents(pos, new);
633 pos->cl_confirm = new->cl_confirm;
634 nfs_mark_client_ready(pos, NFS_CS_READY);
641 /* The callback path may have been inadvertently
642 * changed. Schedule recovery!
644 nfs4_schedule_path_down_recovery(pos);
650 spin_lock(&nn->nfs_client_lock);
653 spin_unlock(&nn->nfs_client_lock);
655 /* No match found. The server lost our clientid */
657 nfs_put_client(prev);
661 #ifdef CONFIG_NFS_V4_1
663 * Returns true if the server major ids match
666 nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
667 struct nfs41_server_owner *o2)
669 if (o1->major_id_sz != o2->major_id_sz)
671 return memcmp(o1->major_id, o2->major_id, o1->major_id_sz) == 0;
675 * Returns true if the server scopes match
678 nfs4_check_server_scope(struct nfs41_server_scope *s1,
679 struct nfs41_server_scope *s2)
681 if (s1->server_scope_sz != s2->server_scope_sz)
683 return memcmp(s1->server_scope, s2->server_scope,
684 s1->server_scope_sz) == 0;
688 * nfs4_detect_session_trunking - Checks for session trunking.
689 * @clp: original mount nfs_client
690 * @res: result structure from an exchange_id using the original mount
691 * nfs_client with a new multi_addr transport
692 * @xprt: pointer to the transport to add.
694 * Called after a successful EXCHANGE_ID on a multi-addr connection.
695 * Upon success, add the transport.
697 * Returns zero on success, otherwise -EINVAL
699 * Note: since the exchange_id for the new multi_addr transport uses the
700 * same nfs_client from the original mount, the cl_owner_id is reused,
701 * so eir_clientowner is the same.
703 int nfs4_detect_session_trunking(struct nfs_client *clp,
704 struct nfs41_exchange_id_res *res,
705 struct rpc_xprt *xprt)
707 /* Check eir_clientid */
708 if (clp->cl_clientid != res->clientid)
711 /* Check eir_server_owner so_major_id */
712 if (!nfs4_check_serverowner_major_id(clp->cl_serverowner,
716 /* Check eir_server_owner so_minor_id */
717 if (clp->cl_serverowner->minor_id != res->server_owner->minor_id)
720 /* Check eir_server_scope */
721 if (!nfs4_check_server_scope(clp->cl_serverscope, res->server_scope))
724 pr_info("NFS: %s: Session trunking succeeded for %s\n",
726 xprt->address_strings[RPC_DISPLAY_ADDR]);
730 pr_info("NFS: %s: Session trunking failed for %s\n", clp->cl_hostname,
731 xprt->address_strings[RPC_DISPLAY_ADDR]);
737 * nfs41_walk_client_list - Find nfs_client that matches a client/server owner
739 * @new: nfs_client with client ID to test
740 * @result: OUT: found nfs_client, or new
741 * @cred: credential to use for trunking test
743 * Returns zero, a negative errno, or a negative NFS4ERR status.
744 * If zero is returned, an nfs_client pointer is planted in "result."
746 * NB: nfs41_walk_client_list() relies on the new nfs_client being
747 * the last nfs_client on the list.
749 int nfs41_walk_client_list(struct nfs_client *new,
750 struct nfs_client **result,
751 const struct cred *cred)
753 struct nfs_net *nn = net_generic(new->cl_net, nfs_net_id);
754 struct nfs_client *pos, *prev = NULL;
755 int status = -NFS4ERR_STALE_CLIENTID;
757 spin_lock(&nn->nfs_client_lock);
758 list_for_each_entry(pos, &nn->nfs_client_list, cl_share_link) {
763 status = nfs4_match_client(pos, new, &prev, nn);
770 * Note that session trunking is just a special subcase of
771 * client id trunking. In either case, we want to fall back
772 * to using the existing nfs_client.
774 if (!nfs4_check_serverowner_major_id(pos->cl_serverowner,
775 new->cl_serverowner))
779 refcount_inc(&pos->cl_count);
786 spin_unlock(&nn->nfs_client_lock);
787 nfs_put_client(prev);
790 #endif /* CONFIG_NFS_V4_1 */
792 static void nfs4_destroy_server(struct nfs_server *server)
796 nfs_server_return_all_delegations(server);
797 unset_pnfs_layoutdriver(server);
798 nfs4_purge_state_owners(server, &freeme);
799 nfs4_free_state_owners(&freeme);
803 * NFSv4.0 callback thread helper
805 * Find a client by callback identifier
808 nfs4_find_client_ident(struct net *net, int cb_ident)
810 struct nfs_client *clp;
811 struct nfs_net *nn = net_generic(net, nfs_net_id);
813 spin_lock(&nn->nfs_client_lock);
814 clp = idr_find(&nn->cb_ident_idr, cb_ident);
816 refcount_inc(&clp->cl_count);
817 spin_unlock(&nn->nfs_client_lock);
821 #if defined(CONFIG_NFS_V4_1)
822 /* Common match routine for v4.0 and v4.1 callback services */
823 static bool nfs4_cb_match_client(const struct sockaddr *addr,
824 struct nfs_client *clp, u32 minorversion)
826 struct sockaddr *clap = (struct sockaddr *)&clp->cl_addr;
828 /* Don't match clients that failed to initialise */
829 if (!(clp->cl_cons_state == NFS_CS_READY ||
830 clp->cl_cons_state == NFS_CS_SESSION_INITING))
835 /* Match the version and minorversion */
836 if (clp->rpc_ops->version != 4 ||
837 clp->cl_minorversion != minorversion)
840 /* Match only the IP address, not the port number */
841 return rpc_cmp_addr(addr, clap);
845 * NFSv4.1 callback thread helper
846 * For CB_COMPOUND calls, find a client by IP address, protocol version,
847 * minorversion, and sessionID
849 * Returns NULL if no such client
852 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
853 struct nfs4_sessionid *sid, u32 minorversion)
855 struct nfs_client *clp;
856 struct nfs_net *nn = net_generic(net, nfs_net_id);
858 spin_lock(&nn->nfs_client_lock);
859 list_for_each_entry(clp, &nn->nfs_client_list, cl_share_link) {
860 if (!nfs4_cb_match_client(addr, clp, minorversion))
863 if (!nfs4_has_session(clp))
867 if (memcmp(clp->cl_session->sess_id.data,
868 sid->data, NFS4_MAX_SESSIONID_LEN) != 0)
871 refcount_inc(&clp->cl_count);
872 spin_unlock(&nn->nfs_client_lock);
875 spin_unlock(&nn->nfs_client_lock);
879 #else /* CONFIG_NFS_V4_1 */
882 nfs4_find_client_sessionid(struct net *net, const struct sockaddr *addr,
883 struct nfs4_sessionid *sid, u32 minorversion)
887 #endif /* CONFIG_NFS_V4_1 */
890 * Set up an NFS4 client
892 static int nfs4_set_client(struct nfs_server *server,
893 const char *hostname,
894 const struct sockaddr_storage *addr,
895 const size_t addrlen,
897 int proto, const struct rpc_timeout *timeparms,
898 u32 minorversion, unsigned int nconnect,
899 unsigned int max_connect,
901 struct xprtsec_parms *xprtsec)
903 struct nfs_client_initdata cl_init = {
904 .hostname = hostname,
910 .minorversion = minorversion,
912 .timeparms = timeparms,
913 .cred = server->cred,
916 struct nfs_client *clp;
918 if (minorversion == 0)
919 __set_bit(NFS_CS_REUSEPORT, &cl_init.init_flags);
921 cl_init.max_connect = max_connect;
923 case XPRT_TRANSPORT_TCP:
924 case XPRT_TRANSPORT_TCP_TLS:
925 cl_init.nconnect = nconnect;
928 if (server->flags & NFS_MOUNT_NORESVPORT)
929 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
930 if (server->options & NFS_OPTION_MIGRATION)
931 __set_bit(NFS_CS_MIGRATION, &cl_init.init_flags);
932 if (test_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status))
933 __set_bit(NFS_CS_TSM_POSSIBLE, &cl_init.init_flags);
934 server->port = rpc_get_port((struct sockaddr *)addr);
936 /* Allocate or find a client reference we can use */
937 clp = nfs_get_client(&cl_init);
941 if (server->nfs_client == clp) {
947 * Query for the lease time on clientid setup or renewal
949 * Note that this will be set on nfs_clients that were created
950 * only for the DS role and did not set this bit, but now will
953 set_bit(NFS_CS_CHECK_LEASE_TIME, &clp->cl_res_state);
955 server->nfs_client = clp;
956 nfs_sysfs_add_server(server);
957 nfs_sysfs_link_rpc_client(server, clp->cl_rpcclient, "_state");
963 * Set up a pNFS Data Server client.
965 * Return any existing nfs_client that matches server address,port,version
968 * For a new nfs_client, use a soft mount (default), a low retrans and a
969 * low timeout interval so that if a connection is lost, we retry through
972 struct nfs_client *nfs4_set_ds_client(struct nfs_server *mds_srv,
973 const struct sockaddr_storage *ds_addr, int ds_addrlen,
974 int ds_proto, unsigned int ds_timeo, unsigned int ds_retrans,
977 struct rpc_timeout ds_timeout;
978 struct nfs_client *mds_clp = mds_srv->nfs_client;
979 struct nfs_client_initdata cl_init = {
981 .addrlen = ds_addrlen,
982 .nodename = mds_clp->cl_rpcclient->cl_nodename,
983 .ip_addr = mds_clp->cl_ipaddr,
986 .minorversion = minor_version,
987 .net = mds_clp->cl_net,
988 .timeparms = &ds_timeout,
989 .cred = mds_srv->cred,
990 .xprtsec = mds_srv->nfs_client->cl_xprtsec,
992 char buf[INET6_ADDRSTRLEN + 1];
994 if (rpc_ntop((struct sockaddr *)ds_addr, buf, sizeof(buf)) <= 0)
995 return ERR_PTR(-EINVAL);
996 cl_init.hostname = buf;
999 case XPRT_TRANSPORT_TCP:
1000 case XPRT_TRANSPORT_TCP_TLS:
1001 if (mds_clp->cl_nconnect > 1) {
1002 cl_init.nconnect = mds_clp->cl_nconnect;
1003 cl_init.max_connect = NFS_MAX_TRANSPORTS;
1007 if (mds_srv->flags & NFS_MOUNT_NORESVPORT)
1008 __set_bit(NFS_CS_NORESVPORT, &cl_init.init_flags);
1011 * Set an authflavor equual to the MDS value. Use the MDS nfs_client
1012 * cl_ipaddr so as to use the same EXCHANGE_ID co_ownerid as the MDS
1013 * (section 13.1 RFC 5661).
1015 nfs_init_timeout_values(&ds_timeout, ds_proto, ds_timeo, ds_retrans);
1016 return nfs_get_client(&cl_init);
1018 EXPORT_SYMBOL_GPL(nfs4_set_ds_client);
1021 * Session has been established, and the client marked ready.
1022 * Limit the mount rsize, wsize and dtsize using negotiated fore
1023 * channel attributes.
1025 static void nfs4_session_limit_rwsize(struct nfs_server *server)
1027 #ifdef CONFIG_NFS_V4_1
1028 struct nfs4_session *sess;
1032 if (!nfs4_has_session(server->nfs_client))
1034 sess = server->nfs_client->cl_session;
1035 server_resp_sz = sess->fc_attrs.max_resp_sz - nfs41_maxread_overhead;
1036 server_rqst_sz = sess->fc_attrs.max_rqst_sz - nfs41_maxwrite_overhead;
1038 if (server->dtsize > server_resp_sz)
1039 server->dtsize = server_resp_sz;
1040 if (server->rsize > server_resp_sz)
1041 server->rsize = server_resp_sz;
1042 if (server->wsize > server_rqst_sz)
1043 server->wsize = server_rqst_sz;
1044 #endif /* CONFIG_NFS_V4_1 */
1048 * Limit xattr sizes using the channel attributes.
1050 static void nfs4_session_limit_xasize(struct nfs_server *server)
1052 #ifdef CONFIG_NFS_V4_2
1053 struct nfs4_session *sess;
1058 if (!nfs4_has_session(server->nfs_client))
1061 sess = server->nfs_client->cl_session;
1063 server_gxa_sz = sess->fc_attrs.max_resp_sz - nfs42_maxgetxattr_overhead;
1064 server_sxa_sz = sess->fc_attrs.max_rqst_sz - nfs42_maxsetxattr_overhead;
1065 server_lxa_sz = sess->fc_attrs.max_resp_sz -
1066 nfs42_maxlistxattrs_overhead;
1068 if (server->gxasize > server_gxa_sz)
1069 server->gxasize = server_gxa_sz;
1070 if (server->sxasize > server_sxa_sz)
1071 server->sxasize = server_sxa_sz;
1072 if (server->lxasize > server_lxa_sz)
1073 server->lxasize = server_lxa_sz;
1077 void nfs4_server_set_init_caps(struct nfs_server *server)
1079 /* Set the basic capabilities */
1080 server->caps |= server->nfs_client->cl_mvops->init_caps;
1081 if (server->flags & NFS_MOUNT_NORDIRPLUS)
1082 server->caps &= ~NFS_CAP_READDIRPLUS;
1083 if (server->nfs_client->cl_proto == XPRT_TRANSPORT_RDMA)
1084 server->caps &= ~NFS_CAP_READ_PLUS;
1087 * Don't use NFS uid/gid mapping if we're using AUTH_SYS or lower
1090 if (nfs4_disable_idmapping &&
1091 server->client->cl_auth->au_flavor == RPC_AUTH_UNIX)
1092 server->caps |= NFS_CAP_UIDGID_NOMAP;
1095 static int nfs4_server_common_setup(struct nfs_server *server,
1096 struct nfs_fh *mntfh, bool auth_probe)
1100 /* data servers support only a subset of NFSv4.1 */
1101 if (is_ds_only_client(server->nfs_client))
1102 return -EPROTONOSUPPORT;
1104 /* We must ensure the session is initialised first */
1105 error = nfs4_init_session(server->nfs_client);
1109 nfs4_server_set_init_caps(server);
1111 /* Probe the root fh to retrieve its FSID and filehandle */
1112 error = nfs4_get_rootfh(server, mntfh, auth_probe);
1116 dprintk("Server FSID: %llx:%llx\n",
1117 (unsigned long long) server->fsid.major,
1118 (unsigned long long) server->fsid.minor);
1119 nfs_display_fhandle(mntfh, "Pseudo-fs root FH");
1121 error = nfs_probe_server(server, mntfh);
1125 nfs4_session_limit_rwsize(server);
1126 nfs4_session_limit_xasize(server);
1128 if (server->namelen == 0 || server->namelen > NFS4_MAXNAMLEN)
1129 server->namelen = NFS4_MAXNAMLEN;
1131 nfs_server_insert_lists(server);
1132 server->mount_time = jiffies;
1133 server->destroy = nfs4_destroy_server;
1139 * Create a version 4 volume record
1141 static int nfs4_init_server(struct nfs_server *server, struct fs_context *fc)
1143 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1144 struct rpc_timeout timeparms;
1147 nfs_init_timeout_values(&timeparms, ctx->nfs_server.protocol,
1148 ctx->timeo, ctx->retrans);
1150 /* Initialise the client representation from the mount data */
1151 server->flags = ctx->flags;
1152 server->options = ctx->options;
1153 server->auth_info = ctx->auth_info;
1155 /* Use the first specified auth flavor. If this flavor isn't
1156 * allowed by the server, use the SECINFO path to try the
1157 * other specified flavors */
1158 if (ctx->auth_info.flavor_len >= 1)
1159 ctx->selected_flavor = ctx->auth_info.flavors[0];
1161 ctx->selected_flavor = RPC_AUTH_UNIX;
1163 /* Get a client record */
1164 error = nfs4_set_client(server,
1165 ctx->nfs_server.hostname,
1166 &ctx->nfs_server._address,
1167 ctx->nfs_server.addrlen,
1168 ctx->client_address,
1169 ctx->nfs_server.protocol,
1172 ctx->nfs_server.nconnect,
1173 ctx->nfs_server.max_connect,
1180 server->rsize = nfs_io_size(ctx->rsize, server->nfs_client->cl_proto);
1182 server->wsize = nfs_io_size(ctx->wsize, server->nfs_client->cl_proto);
1184 server->acregmin = ctx->acregmin * HZ;
1185 server->acregmax = ctx->acregmax * HZ;
1186 server->acdirmin = ctx->acdirmin * HZ;
1187 server->acdirmax = ctx->acdirmax * HZ;
1188 server->port = ctx->nfs_server.port;
1190 return nfs_init_server_rpcclient(server, &timeparms,
1191 ctx->selected_flavor);
1195 * Create a version 4 volume record
1196 * - keyed on server and FSID
1198 struct nfs_server *nfs4_create_server(struct fs_context *fc)
1200 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1201 struct nfs_server *server;
1205 server = nfs_alloc_server();
1207 return ERR_PTR(-ENOMEM);
1209 server->cred = get_cred(fc->cred);
1211 auth_probe = ctx->auth_info.flavor_len < 1;
1213 /* set up the general RPC client */
1214 error = nfs4_init_server(server, fc);
1218 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1225 nfs_free_server(server);
1226 return ERR_PTR(error);
1230 * Create an NFS4 referral server record
1232 struct nfs_server *nfs4_create_referral_server(struct fs_context *fc)
1234 struct nfs_fs_context *ctx = nfs_fc2context(fc);
1235 struct nfs_client *parent_client;
1236 struct nfs_server *server, *parent_server;
1240 server = nfs_alloc_server();
1242 return ERR_PTR(-ENOMEM);
1244 parent_server = NFS_SB(ctx->clone_data.sb);
1245 parent_client = parent_server->nfs_client;
1247 server->cred = get_cred(parent_server->cred);
1249 /* Initialise the client representation from the parent server */
1250 nfs_server_copy_userdata(server, parent_server);
1252 /* Get a client representation */
1253 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1254 rpc_set_port(&ctx->nfs_server.address, NFS_RDMA_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,
1260 XPRT_TRANSPORT_RDMA,
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,
1266 &parent_client->cl_xprtsec);
1269 #endif /* IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA) */
1271 proto = XPRT_TRANSPORT_TCP;
1272 if (parent_client->cl_xprtsec.policy != RPC_XPRTSEC_NONE)
1273 proto = XPRT_TRANSPORT_TCP_TLS;
1274 rpc_set_port(&ctx->nfs_server.address, NFS_PORT);
1275 error = nfs4_set_client(server,
1276 ctx->nfs_server.hostname,
1277 &ctx->nfs_server._address,
1278 ctx->nfs_server.addrlen,
1279 parent_client->cl_ipaddr,
1281 parent_server->client->cl_timeout,
1282 parent_client->cl_mvops->minor_version,
1283 parent_client->cl_nconnect,
1284 parent_client->cl_max_connect,
1285 parent_client->cl_net,
1286 &parent_client->cl_xprtsec);
1290 #if IS_ENABLED(CONFIG_SUNRPC_XPRT_RDMA)
1293 error = nfs_init_server_rpcclient(server, parent_server->client->cl_timeout,
1294 ctx->selected_flavor);
1298 auth_probe = parent_server->auth_info.flavor_len < 1;
1300 error = nfs4_server_common_setup(server, ctx->mntfh, auth_probe);
1307 nfs_free_server(server);
1308 return ERR_PTR(error);
1312 * nfs4_update_server - Move an nfs_server to a different nfs_client
1314 * @server: represents FSID to be moved
1315 * @hostname: new end-point's hostname
1316 * @sap: new end-point's socket address
1317 * @salen: size of "sap"
1318 * @net: net namespace
1320 * The nfs_server must be quiescent before this function is invoked.
1321 * Either its session is drained (NFSv4.1+), or its transport is
1322 * plugged and drained (NFSv4.0).
1324 * Returns zero on success, or a negative errno value.
1326 int nfs4_update_server(struct nfs_server *server, const char *hostname,
1327 struct sockaddr_storage *sap, size_t salen, struct net *net)
1329 struct nfs_client *clp = server->nfs_client;
1330 struct rpc_clnt *clnt = server->client;
1331 struct xprt_create xargs = {
1332 .ident = clp->cl_proto,
1334 .dstaddr = (struct sockaddr *)sap,
1336 .servername = hostname,
1337 /* cel: bleh. We might need to pass TLS parameters here */
1339 char buf[INET6_ADDRSTRLEN + 1];
1340 struct sockaddr_storage address;
1341 struct sockaddr *localaddr = (struct sockaddr *)&address;
1344 error = rpc_switch_client_transport(clnt, &xargs, clnt->cl_timeout);
1348 error = rpc_localaddr(clnt, localaddr, sizeof(address));
1352 if (rpc_ntop(localaddr, buf, sizeof(buf)) == 0)
1353 return -EAFNOSUPPORT;
1355 nfs_server_remove_lists(server);
1356 set_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1357 error = nfs4_set_client(server, hostname, sap, salen, buf,
1358 clp->cl_proto, clnt->cl_timeout,
1359 clp->cl_minorversion,
1360 clp->cl_nconnect, clp->cl_max_connect,
1361 net, &clp->cl_xprtsec);
1362 clear_bit(NFS_MIG_TSM_POSSIBLE, &server->mig_status);
1364 nfs_server_insert_lists(server);
1367 nfs_put_client(clp);
1369 if (server->nfs_client->cl_hostname == NULL) {
1370 server->nfs_client->cl_hostname = kstrdup(hostname, GFP_KERNEL);
1371 if (server->nfs_client->cl_hostname == NULL)
1374 nfs_server_insert_lists(server);
1376 return nfs_probe_server(server, NFS_FH(d_inode(server->super->s_root)));